Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docstring formatting #956

Open
Roger-luo opened this issue May 23, 2024 · 0 comments
Open

docstring formatting #956

Roger-luo opened this issue May 23, 2024 · 0 comments
Labels
backlog design notes and backlogs documentation Improvements or additions to documentation

Comments

@Roger-luo
Copy link
Member

google style (see also sphinix google style) with markdown syntax in the context

short description of the function

Args:
   <name> (<type>): <explaination>

Returns:
   <type>: <explaination>

Raises:
   <exception>: <explaination>

Note:
   <description>

for functions in the builder chain, an extra hint on the following functions can be annotated after the above as

- Your next steps are:

@Roger-luo Roger-luo added documentation Improvements or additions to documentation backlog design notes and backlogs labels May 23, 2024
@Roger-luo Roger-luo mentioned this issue May 23, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog design notes and backlogs documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant