Add quickstart example usage to module docstring #423
Merged
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.
I create new packages rarely enough that I generally don't remeber by heart what command to run. I had the same issue with PkgTemplates.jl and one thing I really liked is that I could do
?PkgTemplate
in the REPL and it would kindly remind me how to use it (to be fair, that was just dumping the Pkg README in the terminal, hence I had to do a bit of scrolling).This PR adds the quickstart example usage to the module docstring, so that people can do
?BestieTemplate
to get a quick reminder of how to use it.Checklist
I am following the contributing guidelines
Tests are passing
Lint workflow is passing
Docs were updated and workflow is passing
CHANGELOG.md was updated