Skip to content

Issues for /docs/VsCode Ext Commands/Automatic Documentation Generation for Code Symbols.md #64

Description

@avb-is-me

Here are the issues I found in the markdown content along with explanations on how to fix them:

  1. Spelling Error: In the "How do I use this extension command?" section, the word "Aestically" should be spelled correctly as "Aesthetically".

  2. Sentence Structure: The sentence "By automating the documentation generation process, this extension aims to improve code maintainability, facilitate knowledge sharing, and streamline the overall development workflow." could be improved by breaking it into two sentences for better readability:

    "By automating the documentation generation process, this extension aims to improve code maintainability and facilitate knowledge sharing. It also helps streamline the overall development workflow."

  3. Configuration JSON Mismatch: The provided dev-docs.json example does not match the specified JSON schema. The issue is in the ai object, where the variablesAndFunctions property should be an array of objects with prompts arrays, but it is defined as an object with a patternProperties property instead. Here's the corrected JSON example:

{
  "quickDoc": {
    "variablesAndFunctions": {
      "prompts": [
        {
          "title": "When should this be used?",
          "question": "When should ${symbol.name} be used?"
        },
        {
          "title": "Examples",
          "question": "Can you provide some examples of how to use ${symbol.name}?"
        }
      ]
    }
  },
  "ai": {
    "variablesAndFunctions": [
      {
        "prompts": [
          {
            "title": "Additional Details",
            "question": "Can you provide additional details about ${symbol.name}?",
            "documentation": "This prompt will generate additional context and information about the code symbol."
          }
        ]
      }
    ],
    "internalTypeFilters": [
      "variable",
      "function"
    ]
  },
  "customRoot": "/path/to/custom/root",
  "workspaceRoot": "/path/to/workspace/root"
}
  1. No Other Issues: The rest of the markdown content appears to be well-written, with no other glaring grammar, spelling, or content issues. The documentation is helpful and aesthetically pleasing.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions