Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
bc3tech committed Jan 5, 2024
1 parent 6923fca commit 034cc67
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
7 changes: 4 additions & 3 deletions DocGpt.Vsix/source.extension.vsixmanifest
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
<?xml version="1.0" ?>
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
<Metadata>
<Identity Id="DocGPT.b5edf920-0ac9-4255-9182-ed263a6e9b18" Version="0.4.1" Language="en-US" Publisher="Brandon H" />
<Identity Id="DocGPT.b5edf920-0ac9-4255-9182-ed263a6e9b18" Version="0.4.2" Language="en-US" Publisher="Brandon H" />
<DisplayName>Doc GPT</DisplayName>
<Description xml:space="preserve">Adds XML Documentation derived from an OpenAI GPT endpoint to .NET members. Can be used with either Azure OpenAI service or OpenAI.com account.</Description>
<MoreInfo>https://github.com/bc3tech/docgpt</MoreInfo>
<License>LICENSE</License>
<GettingStartedGuide>README.md</GettingStartedGuide>
<Icon>icon.jpg</Icon>
<PreviewImage>demo.gif</PreviewImage>
<Tags>dotnet, gpt, llm, ai, xmldoc, xml, documentation, openai, azure</Tags>
<Preview>true</Preview>
</Metadata>
<Installation>
<InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[17.0, 18.0)">
<InstallationTarget Version="[17.0, 18.0)" Id="Microsoft.VisualStudio.Community">
<ProductArchitecture>amd64</ProductArchitecture>
</InstallationTarget>
<InstallationTarget Version="[17.0,18.0)" Id="Microsoft.VisualStudio.Pro">
Expand All @@ -21,7 +22,7 @@
<InstallationTarget Version="[17.0,18.0)" Id="Microsoft.VisualStudio.Enterprise">
<ProductArchitecture>amd64</ProductArchitecture>
</InstallationTarget>
<InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[17.0, 18.0)">
<InstallationTarget Version="[17.0, 18.0)" Id="Microsoft.VisualStudio.Community">
<ProductArchitecture>arm64</ProductArchitecture>
</InstallationTarget>
<InstallationTarget Version="[17.0,18.0)" Id="Microsoft.VisualStudio.Pro">
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The deployment name is found in your Deployment list in Azure AI Studio:

## Usage

The extension ships with two main components:
The extension ships with the following components:

1. Analyzer which finds undocumented members
1. Code fix which generates documentation for the member
Expand All @@ -40,15 +40,15 @@ The analyzer details can be found in the [Shipped](DocGpt.CodeFixes/AnalyzerRele

The code fix also reacts to the built-in XML Documentation diagnostic ([CS1591](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs1591))

> Note: If you'd rather not have the diagnostic fire, you can disable it in your editorconfig, global suppression file, or inline. Then, you can use the refactor (will only fix a single member at a time) to generate documentation.
> Note: If you'd rather not have the diagnostic fire, you can disable it in your .editorconfig, global suppression file, or inline. Then, you can use the refactor (will only fix a single member at a time) to generate documentation.
![DEMO](docs/img/demo.gif) ([demo video](docs/img/demo.mp4))

## Notes

Sending code to GPT can *very* quickly run into token throttling based on endpoint/account configurations. Additionally, please be conscious of the fact that you are very often charged **per token** sent to the API. Sending large code files to the API can quickly run up a large bill.
Sending code to GPT can *very* quickly run into token throttling based on endpoint/account configurations. Additionally, please be conscious of the fact that you are charged **per token** sent to the API. Sending large code files to the API can quickly run up a large bill.

Using the code fixer in a "fix all" scenario results in numerous back-to-back calls to the GPT endpoint. This can request-based throttling. If you encounter this, please try again in a few minutes.
Using the code fixer in a "fix all" scenario results in numerous back-to-back calls to the defined endpoint. This can result in request-based throttling. If you encounter this, please try again in a few minutes.

## FAQ

Expand Down

0 comments on commit 034cc67

Please sign in to comment.