CMakePP / CMinx

Generates API documentation for CMake functions and macros
https://cmakepp.github.io/CMinx/
Apache License 2.0
14 stars 5 forks source link

Better explain param vs keyword #113

Closed ryanmrichard closed 2 years ago

ryanmrichard commented 2 years ago

Is this pull request associated with an issue(s)? Fixes #111

Description This PR expands on the "Documenting a Function" documentation. The goal was primarily to make the distinction between the :param: and :keyword: fields more clear. There's also a very minor change to the basic_function.rst file included in the documentation in order to fix the syntax highlighting.

TODOs None.

codecov[bot] commented 2 years ago

Codecov Report

Base: 96.05% // Head: 96.05% // No change to project coverage :thumbsup:

Coverage data is based on head (499d3de) compared to base (915196a). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #113 +/- ## ======================================= Coverage 96.05% 96.05% ======================================= Files 7 7 Lines 837 837 ======================================= Hits 804 804 Misses 33 33 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `96.05% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#carryforward-flags-in-the-pull-request-comment) to find out more. Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

ryanmrichard commented 2 years ago

🚀 [bumpr] Bumped! New version:v1.0.4 Changes:v1.0.3...v1.0.4