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

Enhances docstrings and Docs/modules #191

Merged
merged 13 commits into from
Jan 28, 2021
Merged

Enhances docstrings and Docs/modules #191

merged 13 commits into from
Jan 28, 2021

Conversation

navidcy
Copy link
Member

@navidcy navidcy commented Jan 27, 2021 •
edited
Loading

Lots of docstrings and docstring refs in the Docs.

Would be helpful to compile the docs locally to review:

julia --project=docs/ -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd()))'; julia --project=docs/ docs/make.jl; open docs/build/index.html

Closes #156.

@navidcy navidcy changed the title Enhances docstrings and Docs/modules [WIP] Enhances docstrings and Docs/modules Jan 27, 2021
@navidcy navidcy changed the title [WIP] Enhances docstrings and Docs/modules Enhances docstrings and Docs/modules Jan 28, 2021
@navidcy navidcy requested review from liasiegelman, BrodiePearson and glwagner and removed request for liasiegelman and BrodiePearson January 28, 2021 08:39
@navidcy navidcy merged commit e0cc346 into master Jan 28, 2021
@navidcy navidcy deleted the ncc/docs-patch branch January 28, 2021 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liasiegelman liasiegelman liasiegelman approved these changes

@glwagner glwagner Awaiting requested review from glwagner

@BrodiePearson BrodiePearson Awaiting requested review from BrodiePearson

Assignees
No one assigned
Labels
📔 documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enhance docstrings
2 participants
@navidcy @liasiegelman