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

Remove last rst docstrings #14530

Merged
merged 4 commits into from
Jan 2, 2016
Merged

Remove last rst docstrings #14530

merged 4 commits into from
Jan 2, 2016

Conversation

hayd
Copy link
Member

@hayd hayd commented Jan 2, 2016

The second commit moves collections docs inline.

cc @MichaelHatherly #14378

Hopefully I have the ref syntax correct.

@MichaelHatherly
Copy link
Member

Thanks @hayd. Ref syntax looks correct. Have you also done a genstdlib.jl run to check nothing got missed when moving them?

"""
heapify!(v, [ord])

In-place [``heapify``](:func:`heapify`).
Copy link
Member

Choose a reason for hiding this comment

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

Should be single backticks for code. Double backticks now produce latex. Also in the PriorityQueue and sprand below.

Copy link
Member Author

Choose a reason for hiding this comment

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

that explains the genstdlib differences! will fix

@hayd
Copy link
Member Author

hayd commented Jan 2, 2016

when doing genstdlib I get:

ErrorException("Cannot find doc for Base.Collections.PriorityQueue{K,V,O<:Base.Order.Ordering}")
WARNING: Mod Base.Collections PriorityQueue
INFO: stdlib/collections.rst: no docs for PriorityQueue(K, V, [ord]) in Base.Collections

any idea why that might happen? repl help works.

@MichaelHatherly
Copy link
Member

I'm not getting that error locally, does your julia include #14513? That should fix that problem I believe. (genstdlib.jl wasn't looking in the .main field of TypeDocs for documentation.)

@hayd
Copy link
Member Author

hayd commented Jan 2, 2016

Ah, no it did not. Edit: that fixes it!

One thing that running the genstdlib seems to do is make the rst one-line, is that known/ok?

@MichaelHatherly
Copy link
Member

One thing that running the genstdlib seems to do is make the rst one-line, is that known/ok?

Yeah, that's expected.

@tkelman
Copy link
Contributor

tkelman commented Jan 2, 2016

lgtm

@tkelman tkelman added the domain:docs This change adds or pertains to documentation label Jan 2, 2016
@hayd
Copy link
Member Author

hayd commented Jan 2, 2016

I ran genstdlib to fix the PriorityQueue message above and got a appveyor fail. I can't see what failed.

ps. I have a PR coming to inline/remove a few other helpdb files.

@tkelman
Copy link
Contributor

tkelman commented Jan 2, 2016

One of the workers hung and timed out. Almost certainly unrelated, but restarted just to be sure.

ps. I have a PR coming to inline/remove a few other helpdb files.

cool

hayd added a commit that referenced this pull request Jan 2, 2016
Remove last rst docstrings
@hayd hayd merged commit ed85e3b into JuliaLang:master Jan 2, 2016
@hayd hayd deleted the rst branch January 2, 2016 23:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants