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

Improve documentation contents #404

Open
2 tasks
fktn-k opened this issue Sep 30, 2024 · 1 comment
Open
2 tasks

Improve documentation contents #404

fktn-k opened this issue Sep 30, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@fktn-k
Copy link
Owner

fktn-k commented Sep 30, 2024

Description

(This is actually not a bug in the library sources.)

We have a number of documentations, e.g., comments in the library sources or documentation sources in docs/mkdocs/docs.
Since English is not my first language, however, the contents may be unclear, redundant or unnatural. They may also contain a number of typos.
Because documentation is a crucial factor (at least for me), I would like to ask for help so we can make them better.

Fixing just one typo is very welcome. Thanks in advance!

Reproduction steps

Just take a look at the documentation. You might find something that could be improved.

Expected vs. actual results

(Omitted since this issue doesn't report a bug in the library.)

Minimal code example

No response

Error messages

No response

Compiler and operating system

(Omitted since this issue doesn't report a bug in the library.)

Library version

develop HEAD

Validation

@fktn-k fktn-k added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 30, 2024
@sndth
Copy link
Contributor

sndth commented Oct 5, 2024

Hi! I've created a pull request where I will be adding documentation fixes (only in the source code, meaning in strings and comments).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants