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

Minor fixes to docs #473

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Minor fixes to docs #473

merged 2 commits into from
Nov 20, 2024

Conversation

mdtanker
Copy link
Member

When reading through the docs I noticed a few small errors which I've fix here.

  1. The sphinx cross-referencing to the dask delayed function (:func:dask.delayed) was not properly working throughout the docs. It looks like the proper reference for it is :func:dask.delayed.delayed. I've updated all these cross-references.

  2. In the typehints of the docstrings the use of an oxford comma seems to result in "or" being treated as an object instead of text; see the docstrings for the scoring parameter of SplineCV for an example. I've removed the oxford comma for a few docstrings that had them.

I built the docs locally and the changes seem to have worked.

@santisoler
Copy link
Member

Nice catches @mdtanker! I'm merging this 🚀

@santisoler
Copy link
Member

Squash and Merge summary

Fix cross-references to dask.delayed.delayed. Remove Oxford comma before "or" when listing possible types for arguments. It made the "or" word to be treated as a possible type instead of the connector.

@santisoler santisoler merged commit 1d24bb0 into fatiando:main Nov 20, 2024
19 checks passed
@mdtanker mdtanker deleted the cross-ref-fixes branch November 20, 2024 23:16
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