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

Documentation updates #12

Merged
merged 7 commits into from
Nov 29, 2023
Merged

Documentation updates #12

merged 7 commits into from
Nov 29, 2023

Conversation

tdrose
Copy link
Member

@tdrose tdrose commented Nov 29, 2023

Small updates in the documentation and README file.

docs/index.rst Outdated
------------
You can install the package via pip:

.. testcode::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The directive testcode is from the Sphinx extension doctest, as configured here. It is derived from the code directive and runs the Python code with pytest. Because of this, the doctests fail. It should be ignored if you replace it by just code.


# 6 ion images of shape 61x78
print(ion_images.shape)
# > (6, 61, 78)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great you found testoutput!
# > (6, 61, 78) is now not needed anymore.

@tdrose
Copy link
Member Author

tdrose commented Nov 29, 2023

Now all tests worked. Apparently an empty line under .. testoutput:: is necessary.

@aeisenbarth
Copy link
Collaborator

I think it's ready to merge

@tdrose tdrose merged commit 91b77dc into master Nov 29, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants