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

Add a useful description to README file. #19

Merged
merged 16 commits into from
Oct 31, 2022
Merged

Conversation

jesper-friis
Copy link
Contributor

@jesper-friis jesper-friis commented Oct 15, 2022

Closes #18

If the mkdocs generated reference documentation is available somewhere, then a link should be added to it from the README file.

@jesper-friis jesper-friis linked an issue Oct 15, 2022 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Oct 15, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.02%. Comparing base (0f2ce17) to head (30956ef).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #19      +/-   ##
==========================================
+ Coverage   70.53%   71.02%   +0.49%     
==========================================
  Files           6        6              
  Lines         526      528       +2     
==========================================
+ Hits          371      375       +4     
+ Misses        155      153       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jesper-friis jesper-friis mentioned this pull request Oct 15, 2022
Copy link
Contributor

@CasperWA CasperWA left a comment

Choose a reason for hiding this comment

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

Please update the README.md accordingly and subsequently run pre-commit run docs-landing-page to update the docs/index.md file.

mkdocstrings supports referencing specific Python API functions, classes, methods, etc. But the landing page/README is special, since it needs to support both GitHub and the documentation, so I'll try to ensure both renditions work, including the automatic referencing in the documentation build. (I have created issue #22 to follow up on this after this PR has been merged.)

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/planned-backends.md Outdated Show resolved Hide resolved
docs/planned-backends.md Outdated Show resolved Hide resolved
docs/tutorial.md Show resolved Hide resolved
@CasperWA
Copy link
Contributor

This branch should have the latest changes from main merged into it as well, which updates the copyright information.

@jesper-friis
Copy link
Contributor Author

Do I really have to mark all our disagreements as resolved in order to ask you for a new review?

@CasperWA
Copy link
Contributor

CasperWA commented Oct 25, 2022

Do I really have to mark all our disagreements as resolved in order to ask you for a new review?

I mentioned only those you haven't reacted to that includes suggested changes that does not focus on the style changes. Please address these suggested changes and comments, yes. Otherwise what's the point of doing a review if it's not taken serious?
Edit: If there are some suggested changes you will not implement, please say so and then "resolve" the specific conversation, or simply "resolve" it without implementing the change.

jesper-friis and others added 5 commits October 30, 2022 22:42
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
@jesper-friis
Copy link
Contributor Author

Please address these suggested changes and comments, yes. Otherwise what's the point of doing a review if it's not taken serious? Edit: If there are some suggested changes you will not implement, please say so and then "resolve" the specific conversation, or simply "resolve" it without implementing the change.

I accepted most suggestions, except those changing the header style.

@jesper-friis jesper-friis merged commit a8491a3 into main Oct 31, 2022
@jesper-friis jesper-friis deleted the 18-improve-readme-file branch October 31, 2022 09:15
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.

Improve README file
3 participants