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

Add eachrow, eachcol, and eachslice to manual #32882

Merged
merged 1 commit into from
Aug 14, 2019
Merged

Add eachrow, eachcol, and eachslice to manual #32882

merged 1 commit into from
Aug 14, 2019

Conversation

mbauman
Copy link
Sponsor Member

@mbauman mbauman commented Aug 13, 2019

These functions are all nicely documented but don't seem to appear in the manual.

Doesn't the documenter CI check the exports against the documented functions? Or didn't it do that at some point in the past? Am I missing it somewhere? Or can we get it back?

These functions are all nicely documented but don't seem to appear in the manual.
@mbauman mbauman added the docs This change adds or pertains to documentation label Aug 13, 2019
@ararslan
Copy link
Member

cc @mortenpi regarding those questions

@mortenpi
Copy link
Contributor

mortenpi commented Aug 14, 2019

Hmm. Documenter has the functionality, but it has actually never checked it for the Julia manual.

We could turn it on, but I think we have plenty of docstrings attached to non-public bindings too. So I think we have two options:

  1. Do checkdocs = :exports, which should make sure that all exported names that have docstrings are (but we'd still miss non-exported public API).
  2. Maintain a hidden page with all the non-public docstrings (they would still show up in the search).

Edit: just some data

Hmm, looking at the list, I am not sure that filtering on exports will work either though: Pkg.GraphType.simplify_graph! is technically an export (from Pkg.GraphType, not from Pkg itself probably), but I doubt that it's a public function..

@nickrobinson251
Copy link
Contributor

nickrobinson251 commented Aug 14, 2019

Shall we open an issue along the lines of "some of these might benefit from docstrings <link to list of undocumented exports> ?" @mortenpi

@mbauman
Copy link
Sponsor Member Author

mbauman commented Aug 14, 2019

See #26919 and #31202 for the documentation efforts, but I was thinking more of the case where we already have docs and it's exported but doesn't appear in the manual — CI for that can happen before everything gets documented.

@mbauman mbauman merged commit f2c3d4d into master Aug 14, 2019
@delete-merged-branch delete-merged-branch bot deleted the mb/eachdoc branch August 14, 2019 21:03
mbauman added a commit that referenced this pull request Aug 14, 2019
@mortenpi
Copy link
Contributor

It turns out that we already have an issue for this: #19529.

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.

5 participants