What’s the best way to get GitHub Copilot to generate docstrings that match my project style?
Asked on Sep 28, 2025
Answer
To get GitHub Copilot to generate docstrings that match your project style, you can provide clear examples of your preferred docstring format within your codebase. This helps Copilot learn and adapt to your style preferences by using the context it gathers from existing documentation.
<!-- BEGIN COPY / PASTE -->
"""
Function Name: add_numbers
Description: Adds two numbers and returns the result.
Parameters:- a (int): The first number.
- b (int): The second number.
Returns:- int: The sum of the two numbers.
"""
def add_numbers(a, b):
return a + b
<!-- END COPY / PASTE -->Additional Comment:
- Ensure your existing docstrings are consistent and well-formatted across your codebase.
- Copilot uses the context from your code to infer styles; more examples lead to better adaptation.
- Consider using a style guide (e.g., Google, NumPy) and apply it consistently to help Copilot learn.
- Review and edit Copilot's suggestions to refine its understanding of your style over time.
Recommended Links: