Document the attenuations constants
Metadata
Current evaluation
Maintainer request to document the permission constants in craft_store/attenuations.py. Resolved: every constant now has a docstring and a Sphinx reference page (docs/reference/attenuations.rst) ships the module via autodata, included in 3.4.0.
Suggested action: close resolved
Reason: Commit 57af685 ("docs: add attenuation constants reference", merged PR #400) added docs/reference/attenuations.rst, which documents all 18 constants via `.. autodata::` directives under "Read-write" and "Read-only" headings and is wired into docs/reference/index.rst; every constant in craft_store/attenuations.py also carries its own attribute docstring. The changelog confirms the work shipped in 3.4.0 (2026-07-16). The original complaint that "lack of documentation ... made us think these weren't a thing" no longer applies.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
12
Quick Win:
11
Complexity:
5
Confidence:
95
Actionability:
95
|
close resolved | Maintainer request to document the permission constants in craft_store/attenuations.py. Resolved: every constant now has a docstring and a Sphinx reference page (docs/reference/attenuations.rst) ships the module via autodata, included in 3.4.0. | |
| stealth/space-bunny-alpha |
Impact:
22
Quick Win:
16
Complexity:
12
Confidence:
92
Actionability:
84
|
keep open | Add documentation for the constants in attenuations.py to clarify their purpose and prevent mistaken assumptions that attenuation behavior is absent. | |
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
15
Quick Win:
14
Staleness:
85
Complexity:
10
Confidence:
85
Support Request:
0
|
close not a bug | Documentation task for attenuations.py constants. The constants now have docstrings and a reference page exists at docs/reference/attenuations.rst. PR #2 merged with this work. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
40
Complexity:
10
Confidence:
90
Support Request:
5
|
keep open | Triaged documentation task to add docstrings to constants in attenuations.py. Created by a maintainer 28 days ago with no further progress or assignee. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
10
Complexity:
5
Confidence:
90
Support Request:
0
|
keep open | Request to add documentation for constants in attenuations.py. The issue is triaged and awaiting implementation. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
craft-store#400
(confidence 97%)
Merged PR 'docs: add attenuation constants reference' by lengau, squashed as commit 57af685; approved by two reviewers with lint/test jobs passing. Directly implements the requested documentation.
-
Related To:
craft-store#399
(confidence 90%)
Merged PR adding constants for more known attenuations (commit 19166ba), which fixed #386 and expanded the set of constants that now require documenting.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2 attenuations: new module with documented constants (CRAFT-453) | craft-store | merged | Merged canonical/craft-store#2, adding a new attenuations module with documented constants for CRAFT-453 in commit c0bc57c. |