Skip to content

Conversation

@fingolfin
Copy link
Member

Extracted from PR #2270

@codecov
Copy link

codecov bot commented Jan 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.32%. Comparing base (ac5ce09) to head (b1d8288).
⚠️ Report is 11 commits behind head on master.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.
"""
Copy link
Member

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

Copy link
Member Author

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

@lgoettgens lgoettgens changed the title Merge 'characteristic' docstrings Merge characteristic docstrings Jan 7, 2026

```julia
```@docs
characteristic(R::NCRing)
Copy link
Member

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

@lgoettgens lgoettgens merged commit 07a84b5 into master Jan 7, 2026
23 checks passed
@lgoettgens lgoettgens deleted the mh/characteristic-docstrings branch January 7, 2026 11:29
@lgoettgens lgoettgens added the release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes label Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants