/docstring

/docstring generates or improves docstrings.

Use it to enhance documentation quality and maintainability by creating clear and consistent docstrings for functions, classes and modules.

Using /docstring

1. Open a file: Open a file in your project.

2. Activate Qodo Gen: Click the Qodo Gen logo in the Extensions bar.

3. Focus: Select the part of the code you want to get a docstring for. It could be a few lines of code, a method, an entire file and more. Check out our Focus documentation to learn more.

4. Call the Command: Type /docstring in the chatbox and hit the send key or click the arrow button.

5. (Optional) Add optional instructions: You can give Qodo Gen any specific guidelines.

6. Result! Qodo Gen will analyze the selected code and generate a suitable docstring, or suggest improvements to existing documentation.

7. (Optional) Continue your chat: To give Qodo Gen more instructions, just type a command or ask a question to keep chatting.

Example

Command

/docstring [optional instructions]

Response

[ docstring tailored for your code. ]

docstring generation example