RFC: Added doc/DocCheck.jl: functions for checking documentation status #3120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Whoops, there's an extra set of commits there... |
|
Should be good now. |
|
I should add, |
|
I would rather have the undocumented stuff in external scripts rather than base. Base is getting too large. Very useful though. |
|
Ok. How about I move it to the doc directory? |
|
Yes the doc directory seems fine. |
* undefined_exports(m::Module): list the undefined exportss in a module * undocumented(), undocumented_by_file(), undocumented_rst(): produce a list of undocumented methods in various formats * isdeprecated(fn): true if fn is deprecated Additional functions in base: * current_module(): return the current module * functionlocs(fn): return all function locations; (functionloc(fn) returns just the first) Also: * commented out undefined functions in exports.jl (these could probably be removed)
|
Okay, this is now in the doc directory. It's self contained, and a module, so it could also be moved to be an external module easily enough. |
JeffBezanson
added a commit
that referenced
this pull request
May 17, 2013
RFC: Added doc/DocCheck.jl: functions for checking documentation status
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The following are defined in doc/DocCheck.jl
undefined_exports(m::Module): list the undefined exports in a moduleundocumented(),undocumented_by_file(),undocumented_rst(): produce a list of undocumented methods in various formatsisdeprecated(fn): true if fn is deprecatedThis request also:
current_module(): return the current modulefunctionlocs(fn): return all function locations (functionloc(fn)just returns the first)Edit: Updated to reflect current contents