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 quickstart example usage to module docstring #423

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

lucaferranti
Copy link
Contributor

@lucaferranti lucaferranti commented Sep 4, 2024

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

@lucaferranti
Copy link
Contributor Author

(not sure if this even needs a changelog update, but I can add one if needed)

Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7281bcb) to head (0775e71).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #423   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          104       104           
=========================================
  Hits           104       104           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/BestieTemplate.jl Outdated Show resolved Hide resolved
Copy link
Collaborator

@abelsiqueira abelsiqueira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is great!
There is no need for a changelog update.

@abelsiqueira abelsiqueira changed the title add quickstart example usage to module docstring Add quickstart example usage to module docstring Sep 5, 2024
@abelsiqueira abelsiqueira merged commit 82bd740 into JuliaBesties:main Sep 5, 2024
6 checks passed
@lucaferranti lucaferranti deleted the patch-1 branch September 5, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants