-
Notifications
You must be signed in to change notification settings - Fork 123
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 a section to convert the app to an executable to examples #2100
Conversation
for more information, see https://pre-commit.ci
Codecov Report
@@ Coverage Diff @@
## main #2100 +/- ##
=======================================
Coverage 86.43% 86.44%
=======================================
Files 45 45
Lines 7971 7981 +10
=======================================
+ Hits 6890 6899 +9
- Misses 1081 1082 +1 |
@clatapie please do review this PR too. Thank you! |
The error comes from the argument |
When a word that you need is not accepted by
|
I wasn't sure about doing that because |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure the documentation is sort of complete. Someone reading the document should understand why we are doing what we are doing. For further details you should give links which the user can follow easy.
Please address the comments and ping me when ready.
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
Pinging @PipKat for documentation review. |
Co-authored-by: German <[email protected]>
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added doc review comments per @germa89's request.
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, it looks good to me 👍
doc/source/examples/extended_examples/executable/executable.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just fix/close the conversation we have still open. Also there are some Vale warnings regarding the ellipsis. You can use .. vale off
and .. vale on
to hide them.
No description provided.