-
Notifications
You must be signed in to change notification settings - Fork 73
Merge characteristic docstrings
#2271
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
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2271 +/- ##
=======================================
Coverage 88.32% 88.32%
=======================================
Files 126 126
Lines 31804 31804
=======================================
Hits 28090 28090
Misses 3714 3714 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This is part of the general ring interface, so no need to mention this everywhere.
| Return the characteristic of the ring `R`. If the characteristic | ||
| is not known, an exception is raised. | ||
| """ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new docstring should be included in the docs somewhere
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC it already is, but I'll double check tomorrow
characteristic docstrings
|
|
||
| ```julia | ||
| ```@docs | ||
| characteristic(R::NCRing) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have overseen this. Here, we add the docstring. So this resolves my other comment
Extracted from PR #2270