Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add missing features documentation #1260

Merged
merged 1 commit into from
Sep 6, 2023
Merged

Add missing features documentation #1260

merged 1 commit into from
Sep 6, 2023

Conversation

Stygmates
Copy link

@Stygmates Stygmates commented Sep 6, 2023

The rustdoc isn't up to date with the readme and features documentation is missing. This PR solves this.

@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

Merging #1260 (589e51f) into 0.4.x (8509c25) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            0.4.x    #1260   +/-   ##
=======================================
  Coverage   91.37%   91.37%           
=======================================
  Files          37       37           
  Lines       16448    16448           
=======================================
  Hits        15030    15030           
  Misses       1418     1418           
Files Changed Coverage Δ
src/lib.rs 95.58% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@pitdicker
Copy link
Collaborator

pitdicker commented Sep 6, 2023

What I still wanted to do was sync the documentation in lib.rs with the changes to the README in #1111. Do you want to copy those also, instead of only the features (except the part about the license)?

@Stygmates
Copy link
Author

What I still wanted to do was sync the documentation in lib.rs with the changes to the README in #1111. Do you want to copy those also, instead of only the features (except the part about the license)?

Done, let me know if you want me to change something else!

@pitdicker
Copy link
Collaborator

Thank you!

I am not sure what happened, you have parts of the README with lines from the current docs in between them?

Copy link
Collaborator

@pitdicker pitdicker left a comment

Choose a reason for hiding this comment

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

Please also squash the commits 😄.

@Stygmates
Copy link
Author

All done! Thanks for keeping up with me!

Copy link
Collaborator

@pitdicker pitdicker left a comment

Choose a reason for hiding this comment

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

Thank you!

@pitdicker pitdicker merged commit 84334df into chronotope:0.4.x Sep 6, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants