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.

Sign up for GitHub

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

Jump to bottom

[Documentation] Automatized proof reading the docs & docstrings ? #123

Open
lrnv opened this issue Feb 4, 2024 · 1 comment
Open

[Documentation] Automatized proof reading the docs & docstrings ? #123

lrnv opened this issue Feb 4, 2024 · 1 comment

Comments

@lrnv
Copy link
Owner

lrnv commented Feb 4, 2024

We could use something like that to proof-read the docs again : https://forem.julialang.org/danielvandh/efficiently-fixing-typos-in-documentation-1j88
@lrnv lrnv mentioned this issue Feb 4, 2024
Closed
@lrnv
Copy link
Owner Author

lrnv commented Feb 5, 2024

@lucaferranti Do you by chance know a guide on how to setup automatic proof-reading in CI for docs (doc pages but also docstrings) ? I found (upper link) something to do it locally by hand, but no guide for something automatic.

@lrnv lrnv changed the title Automatized proof reading the docs [Documentation] Automatized proof reading the docs & docstrings ? Feb 7, 2024
@lrnv lrnv assigned lrnv and unassigned lrnv Feb 7, 2024
@lrnv lrnv added the enhancement New feature or request label Feb 7, 2024
@lrnv lrnv removed the enhancement New feature or request label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lrnv