Improve documentation #691
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asvetlov
reviewed
Nov 25, 2024
asvetlov
approved these changes
Nov 25, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #691 +/- ##
=======================================
Coverage 94.34% 94.34%
=======================================
Files 4 4
Lines 1309 1309
Branches 78 78
=======================================
Hits 1235 1235
Misses 66 66
Partials 8 8 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
This PR improves the accessibility of the library for new users and shows limitations to consider. It also adds a link to the new
culsanslibrary to reduce the chance of irrelevant issues for thejanuslibrary.Are there changes in behavior for the user?
There are no behavior changes for users.
Related issue number