search

hypothesis / client

The Hypothesis web-based annotation client.
Other
642 stars 197 forks source link

Update `allowLeavingGroups` docs to match reality #6639

Closed robertknight closed 3 weeks ago

robertknight commented 3 weeks ago

Update the documentation to match the current behavior. As noted in https://github.com/hypothesis/client/pull/6638, the code comments and behavior were inconsistent. Since changing the behavior is potentially disruptive, that PR changed the comments instead. This commit updates the publisher-facing documentation.

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.42%. Comparing base (d14c255) to head (9a7900c). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #6639 +/- ## ======================================= Coverage 99.42% 99.42% ======================================= Files 270 270 Lines 10172 10172 Branches 2418 2418 ======================================= Hits 10114 10114 Misses 58 58 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.