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

Documentation refinements #14

Merged
merged 33 commits into from
Jan 28, 2025
Merged

Documentation refinements #14

merged 33 commits into from
Jan 28, 2025

Conversation

adriesse
Copy link
Contributor

Documentation refinements

Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@adriesse adriesse requested a review from echedey-ls January 28, 2025 16:09
Copy link
Member

@echedey-ls echedey-ls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General comments, feel free to proceed as you'd like ;)

Just in case, I want to be pedantic and discourage the the duplication of README content, it's pretty uncommon to see that specially cause it's not really needed to have such a difference.

README_PYPI.md Outdated Show resolved Hide resolved
README_PYPI.md Show resolved Hide resolved
docs/api_reference/iec61853.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
docs/user_guide/index.rst Outdated Show resolved Hide resolved
docs/user_guide/installation.rst Show resolved Hide resolved
docs/user_guide/quick-overview.rst Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@adriesse
Copy link
Contributor Author

General comments, feel free to proceed as you'd like ;)

Just in case, I want to be pedantic and discourage the the duplication of README content, it's pretty uncommon to see that specially cause it's not really needed to have such a difference.

I don't want a big long readme on pypi, so this is my low-tech solution. :)

@adriesse
Copy link
Contributor Author

General comments, feel free to proceed as you'd like ;)

Thanks so much! There is still plenty of room for improvements, especially the user guide section, but I think it's a respectable for a first release.

@adriesse adriesse merged commit 349968b into main Jan 28, 2025
5 checks passed
@adriesse adriesse deleted the docu branch January 30, 2025 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants