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.

Sign up for GitHub

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

Jump to bottom

Types in documentation #3

Open
mtorpey opened this issue Apr 10, 2024 · 0 comments
Open

Types in documentation #3

mtorpey opened this issue Apr 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mtorpey
Copy link

mtorpey commented Apr 10, 2024

The doc is coming along nicely, but there are some improvements that could be made.

  1. The "Returns" statement should just describe the type of the thing that's returned. So for example, GraphvizHead returns "the head of the provided graphviz edge" but should instead return "A graphviz edge object". AsString returns not "the dot representation of the graphviz object" but simply "a string."
  2. Specify the types of the arguments in the doc. I believe Autodoc has a construct for this.
@mtorpey mtorpey added the documentation Improvements or additions to documentation label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mtorpey