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

Move docstrings from helpdb/Base.jl inline #22521

Closed
wants to merge 1 commit into from

Conversation

xorJane
Copy link
Contributor

@xorJane xorJane commented Jun 24, 2017

Yay hackathon <3

Thanks in advance for reviewing!

@kshyatt kshyatt added the docs This change adds or pertains to documentation label Jun 25, 2017
@KristofferC
Copy link
Member

I wonder if some of these docstrings occur before enough of the documentation system itself has been loaded (which would explain the CI problems).

@fredrikekre
Copy link
Member

I wonder if some of these docstrings occur before enough of the documentation system itself has been loaded (which would explain the CI problems).

Yes, I don't think we can have inline docstrings in boot.jl for instance, that's why I added the number docstrings in helpdb/Base.jl in #22067

@KristofferC
Copy link
Member

Perhaps we should have a comment on those helpdb docstrings that are difficult to move.

@fredrikekre
Copy link
Member

Or possibly helpdb/boot.jl etc, which would be more contained than having everything in helpdb/Base.jl?

@KristofferC
Copy link
Member

Yes

@KristofferC
Copy link
Member

KristofferC commented Jun 25, 2017

So the easiest way forward would be to move some of the stuff (boot.jl) back into the helpdb file. You can check that everything works locally by rebuilding Julia.

@tkelman
Copy link
Contributor

tkelman commented Jun 26, 2017

or base/docs/basedocs.jl for things that are tricky due to bootstrap order

@xorJane
Copy link
Contributor Author

xorJane commented Jun 28, 2017

Thank you for the feedback! I'm realizing that a PR that touches this many lines of docs is harder to review and more likely to end up with merge conflicts. So, I'm going to break this PR up into a few smaller PR's.

@JeffBezanson
Copy link
Member

I'll assume this was superseded by the smaller PRs; reopen if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants