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

Fix docstring references in the manual #2233

Merged
merged 6 commits into from
May 8, 2020
Merged

Conversation

mortenpi
Copy link
Contributor

@mortenpi mortenpi commented May 7, 2020

Try to fix #2232.

@mortenpi mortenpi changed the title Fix docstrings references in the manual WIP: Fix docstrings references in the manual May 7, 2020
@mortenpi
Copy link
Contributor Author

mortenpi commented May 8, 2020

Ok, this should now actually resolve all the docstring referencing issues:

  • Remove references to docstring that don't exist from the manual
  • Remove at-refs to functions that don't have (DataFrames-specific) docstrings anymore
  • Add in all the docstrings that exists, but were not included in the manual.

I also enabled strict = true for makedocs -- this should fail the documentation build if a PR introduces some new referencing problems.

@mortenpi mortenpi changed the title WIP: Fix docstrings references in the manual WIP: Fix docstring references in the manual May 8, 2020
Copy link
Member

@bkamins bkamins left a comment

Choose a reason for hiding this comment

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

Thank you - I will merge this once the CI passes and later I will rewrite the whole page to be more structured.

@mortenpi mortenpi changed the title WIP: Fix docstring references in the manual Fix docstring references in the manual May 8, 2020
@bkamins bkamins merged commit e061647 into JuliaData:master May 8, 2020
@bkamins
Copy link
Member

bkamins commented May 8, 2020

Thank you!

@mortenpi mortenpi deleted the patch-1 branch May 9, 2020 03:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

first/last/etc. documentation problem
2 participants