doc: various improvements to documentation #550
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
Signed-off-by: Arthur Bit-Monnot <abitmonnot@laas.fr>
…and reference the just file
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #550 +/- ##
=======================================
Coverage 84.96% 84.96%
=======================================
Files 200 200
Lines 26433 26433
=======================================
Hits 22458 22458
Misses 3975 3975 ☔ View full report in Codecov by Sentry. |
mikand
approved these changes
Dec 22, 2023
| You can use it to find out common commands (e.g. running tests, reformatting the code) or use it directly with the `just <https://github.com/casey/just>`_ command line tool. | ||
|
|
||
| Whenever you see a command ``just RECIPE_NAME`` in this page, it means the command is available as a just recipe. | ||
| You can run it directly with ``just`` or check the ``justfile`` for the actual commands to run. |
There was a problem hiding this comment.
Wow! I did not know just, I was missing out!
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 provides several minor improvements to the documentation. It mostly polishes and fixes some minor things.
A notable changes is regarding the "Optimality" documentation that now refers to ANytime planning and suggest using it when no optimality guarantee is needed.
The other important change is to the contributors guide that is now much more complete.
The most controversial thing is the addition of a
justfileat the root of the repository that should aim at documenting, making discoverable and easily accessible the various commands taht are useful to interact with the code base.just is command line utility that you can think of as a much better
make. If you haven't used it I strongly suggest giving it a try.Even without using it the justfile is useful in centralizing the different commands (without going into the CI configuration as I usually have to do).
The objective of the PR is not to generalize the usage of just but if there is consensus that it is a desirable thing it could be be extended (e.g. for running the tests) and used in CI to avoid duplication.