KO
|
EN
gitlite — search
Search
#python
#java
#python3
#arduino
#golang
#machine-learning
#rust
#html
#flask
#javascript
#seismology
#nodejs
ModuleDocstrings.jl
★ 13
Open GitHub ↗
No description available.
Download README (.md)
Explore Similar Repositories
BlackAddr_Projects
:
Projects using the Black Addr Products such as Teensy Guitar Shield
STC89C52-smart_dustbin
:
基于STC单片机的智能垃圾箱
nest-graphql-prisma-api
:
No description available.
micro_ros_azure_rtos_app
:
micro-ROS app for Azure RTOS
HOML-Notes
:
Hands-on Machine Learning with Scikit-Learn and Tensorflow 2nd edition notes along with code.
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
ModuleDocstrings.jl
?
Download (.md)
# ModuleDocstrings [](https://ModuleDocstrings.juliadocs.org/stable) [](https://github.com/JuliaDocs/ModuleDocstrings.jl/actions) [](https://codecov.io/gh/JuliaDocs/ModuleDocstrings.jl) A package to create simple "module docstrings" for Julia packages. These are targeted at summarizing the main components of your package, essentially as a prompt or reminder to users. For example: ```julia julia> using ModuleDocstrings help?> ModuleDocstrings search: ModuleDocstrings • ModuleDocstrings.generate: Create an API summary docstring for a module. • ModuleDocstrings.write: add an API summary docstring to a package. ``` This reminds users that the two main functions are `ModuleDocstrings.generate` and `ModuleDocstrings.write`. These summaries are brief; to learn more about a particular function, read its help in full: ```julia help?> ModuleDocstrings.generate ModuleDocstrings.generate(mod::Module) Return an API summary string for mod. The summary is assembled from all docstrings in the package, picking the first sentence of each docstring. When added to the package (see ModuleDocstrings.write), you should expect to make edits by hand: • exclude docstrings that shouldn't appear in the API summary • rephrase summaries for greater clarity or compactness (alternatively, consider making such changes to the original docstring) ``` Once you've added the docstring to a `Pkg.develop`ed package, it can be submitted as a pull request.
