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

DOC: Add examples to the merge_sort documentation #15

Open
seberg opened this issue Aug 20, 2024 · 0 comments
Open

DOC: Add examples to the merge_sort documentation #15

seberg opened this issue Aug 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@seberg
Copy link
Collaborator

seberg commented Aug 20, 2024

The merge sort documentation currently describes the parameters and results. It would be good to add a simple example at the end of the current documentation.

Working on this issue

This means finding the merge_sort implementation and modifying the docstring to insert something like:

Examples
--------
>>> ...
result
>>> ...
example

Make sure that the output is exactly as on an interactive terminal, and that the inputs in >>> conform to the style.
(We are currently not testing correctness in CI, but many projects do.)

The examples can include explaining tests if there is a blank line after each example. See https://numpydoc.readthedocs.io/en/latest/format.html#examples for more information.

@seberg seberg added the documentation Improvements or additions to documentation label Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant