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

Fix doc system part of #21016 #21036

Merged
merged 7 commits into from
Mar 27, 2017
Merged

Fix doc system part of #21016 #21036

merged 7 commits into from
Mar 27, 2017

Conversation

helgee
Copy link
Contributor

@helgee helgee commented Mar 15, 2017

I revamped the signature extraction to make MultiDoc work with UnionAll.

x-ref: #21016

cc: @MichaelHatherly

@helgee helgee mentioned this pull request Mar 15, 2017
Closed
@helgee helgee changed the title RFC: Fix doc system part of #21016 Fix doc system part of #21016 Mar 15, 2017
@helgee
Copy link
Contributor Author

helgee commented Mar 15, 2017 •
edited
Loading

Documenter does not seem to like the changes. Investigating...

EDIT: It is complaining about missing docstrings.

475.278910  !! No docs found for 'Base.permute!{T}(::Any, ::AbstractArray{T, 1})'. [src/stdlib/arrays.md]
476.019033  !! No docs found for 'Base.Dates.CompoundPeriod{P <: Base.Dates.Period}(::Array{P,1})'. [src/stdlib/dates.md]

@helgee
Copy link
Contributor Author

helgee commented Mar 15, 2017

It seems a (dis-)advantage of this PR is that the signature in the docs must be exactly the same as the signature in the code so that Documenter can find the docstring.

@helgee
Copy link
Contributor Author

helgee commented Mar 15, 2017

This is the corresponding PR for Documenter.jl that enables the use of where expressions in @docs blocks: JuliaDocs/Documenter.jl#446

JeffBezanson
JeffBezanson reviewed Mar 15, 2017
View reviewed changes
base/docs/Docs.jl Outdated
for i = length(tv):-1:1
sig = Expr(:where, sig, tv[i])
sig = Expr(:where, sig, :($(tv[i][1]) <: $(tv[i][2])))
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

These expressions can also have the forms a >: b and a <: b <: c.

@ararslan ararslan added the docsystem The documentation building system label Mar 15, 2017
@helgee
Copy link
Contributor Author

helgee commented Mar 15, 2017

Addressed comment.

@helgee
Copy link
Contributor Author

helgee commented Mar 20, 2017

Is there anything left to do for me to get this merged?

@StefanKarpinski
Copy link
Sponsor Member

No, we just need someone who knows the doc system to take a look and merge it.

@mortenpi
Copy link
Contributor

The fixes on Documenter's part were released in v0.9.2. I guess Documenter's version should also be bumped then?

@JeffBezanson JeffBezanson added this to the 0.6.0 milestone Mar 25, 2017
@KristofferC
Copy link
Sponsor Member

I feel this could be merged. Anyone opposed?

@tkelman tkelman merged commit f65b8ab into JuliaLang:master Mar 27, 2017
@helgee helgee deleted the unionalldocs branch March 27, 2017 13:18
@matthias314 matthias314 mentioned this pull request Mar 23, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JeffBezanson JeffBezanson JeffBezanson left review comments

@MichaelHatherly MichaelHatherly Awaiting requested review from MichaelHatherly

Assignees
No one assigned
Labels
docsystem The documentation building system
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@helgee @StefanKarpinski @mortenpi @KristofferC @JeffBezanson @tkelman @ararslan