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

Examples on the documentation #117

Open
cvvergara opened this issue Jul 28, 2020 · 0 comments
Open

Examples on the documentation #117

cvvergara opened this issue Jul 28, 2020 · 0 comments
Labels
Standard

Comments

@cvvergara
Copy link
Member

cvvergara commented Jul 28, 2020 •
edited
Loading

About signature examples

  • They should be small
  • They should be well thought of in such a way that the documentation is teaching a different aspect of the call

About Additional examples

  • Don't add one unless absolutely necessary
  • Remember that Dijkstra documentation teaches equivalences, so dont' teach equivalences in your documentation.
  • An additional example to be added must have been discussed in an issue and approved as an additional example
@cvvergara cvvergara added enhancement New feature or request Standard and removed enhancement New feature or request labels Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Standard
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cvvergara