Skip to content

Conversation

@markstory
Copy link
Member

Expand the documentation for features.handler and features.manager.

Expand the documentation for features.handler and features.manager.
@markstory markstory requested a review from a team July 25, 2024 12:07
@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Jul 25, 2024
@codecov
Copy link

codecov bot commented Jul 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.14%. Comparing base (ccf1662) to head (8b8dc48).
Report is 153 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #74943      +/-   ##
==========================================
+ Coverage   70.65%   78.14%   +7.48%     
==========================================
  Files        6742     6752      +10     
  Lines      300897   301371     +474     
  Branches    51757    51843      +86     
==========================================
+ Hits       212609   235495   +22886     
+ Misses      81442    59536   -21906     
+ Partials     6846     6340     -506     
Files Coverage Δ
src/sentry/features/__init__.py 100.00% <ø> (ø)
src/sentry/features/handler.py 92.30% <100.00%> (ø)
src/sentry/features/manager.py 95.03% <ø> (ø)

... and 1340 files with indirect coverage changes

@markstory markstory requested a review from a team July 29, 2024 15:22
Copy link
Member

@cmanallen cmanallen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay documentation!

Comment on lines 20 to 26
"""
Base class for defining custom logic for feature decisions.
Subclasses should implement `has` and contain the logic
necessary for the feature check.
"""

Copy link
Member

@cmanallen cmanallen Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is the root it may be helpful to enumerate common use-cases, any recommended do's and don'ts, file locations to place flags, instructions for (or links to instructions for) enabling flags in relay and other services, etc.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a bit more context, and can go through the getsentry code and expand documentation there as well.

@markstory markstory merged commit 340ffca into master Jul 29, 2024
@markstory markstory deleted the chore-feature-docs branch July 29, 2024 17:23
@github-actions github-actions bot locked and limited conversation to collaborators Aug 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants