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 #691

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Improve documentation #691

merged 3 commits into from
Nov 25, 2024

Conversation

x42005e1f
Copy link
Contributor

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 culsans library to reduce the chance of irrelevant issues for the janus library.

Are there changes in behavior for the user?

There are no behavior changes for users.

Related issue number

README.rst Outdated Show resolved Hide resolved
@asvetlov asvetlov enabled auto-merge (squash) November 25, 2024 09:41
@asvetlov asvetlov merged commit aad077b into aio-libs:master Nov 25, 2024
9 checks passed
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.34%. Comparing base (d2e195d) to head (53d8179).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants