Added doc/UNDOCUMENTED.rst, functions for generating #3912
Merged
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
This collects all known undocumented modules and functions and
puts them in doc/UNDOCUMENTED.rst, using standard function and
method templates so they can be easily filled in and copied to
the correct .rst file in doc/stdlib.
This file can be regenerated with
```julia
cd("$JULIA_HOME/../../doc")
import DocCheck
DocCheck.gen_undocumented_template()
```
JeffBezanson
added a commit
that referenced
this pull request
Aug 2, 2013
Added doc/UNDOCUMENTED.rst, functions for generating
|
That is pretty slick! |
|
It it pretty slick, and the list is not nearly as long as I feared. This is probably a really great way to encourage documentation of the remaining undocumented functions. |
|
Glad you like it! |
IanButterworth
pushed a commit
that referenced
this pull request
Jun 4, 2024
Stdlib: Pkg URL: https://github.com/JuliaLang/Pkg.jl.git Stdlib branch: master Julia branch: master Old commit: ed7a8dca8 New commit: 4e43058c2 Julia version: 1.12.0-DEV Pkg version: 1.12.0 Bump invoked by: @IanButterworth Powered by: [BumpStdlibs.jl](https://github.com/JuliaLang/BumpStdlibs.jl) Diff: JuliaLang/Pkg.jl@ed7a8dc...4e43058 ``` $ git log --oneline ed7a8dca8..4e43058c2 4e43058c2 Merge pull request #3887 from carlobaldassi/validate_versions bc7c3207d abort querying more pacakge for hint auto complete (#3913) a4016aed2 precompile repl switch (#3910) a48c9c645 Fixed glitch in the manual (#3912) d875aa213 Add timeout and new tests for resolver aeb55f7f0 run artifact selection code with minimal compilation (#3899) 0180a0105 avoid doing some checks if the package will not be showed in status output (#3897) c6c7ed502 improve precompilation for `st` in the Pkg REPL (#3893) bffd0633c Add version validation during Graph simplification c2ad07003 Fix padding in resolve's log journal printing 3eb86d29f Revert #2267, with better log message acdbb727e Small extra check in Graph's check_consistency 1d446c224 Fix small bug in Graph constructor 3efc3cbff Fix show method for VersionSpecs ``` Co-authored-by: Dilum Aluthge <[email protected]>
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.
This collects all known undocumented modules and functions and
puts them in doc/UNDOCUMENTED.rst, using standard function and
method templates so they can be easily filled in and copied to
the correct .rst file in doc/stdlib.
This file can be regenerated with
#2242 should be updated as functions are documented.