← Back to issue list

Document the attenuations constants

View original Github issue

Metadata

Project
craft-store
Number
#396
Type
issue
State
open
Author
lengau
Labels
Type: Documentation Status: Triaged
Created
Updated
Closed

Current evaluation

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.

Suggested action: close not a bug

Reason: The documentation work requested in this issue has already been completed. PR #2 ('attenuations: new module with documented constants') was merged, adding docstrings to all constants in craft_store/attenuations.py and creating docs/reference/attenuations.rst with full API reference documentation via autodata directives. The issue is resolved.

Impact: 15 Quick Win: 13.5 Staleness: 85 Complexity: 10 Confidence: 85 Support Request: 0

Issue body

### What needs to get done Document the constants in `attenuations.py`. ### Why it needs to get done The lack of documentation for these made us think these weren't a thing.

Evaluation history

Date Model Scores Action Summary
qwen3.6-35b-a3b-mtp-q6
Impact: 15
Quick Win: 13.5
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 10
Confidence: 95
Support Request: 0
keep open Request to add documentation for constants in attenuations.py. Recently triaged and labeled as documentation by a maintainer. Clear, actionable task.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: craft-store#2 (confidence 95%)

    PR #2 merged the attenuations module with documented constants, including docstrings for each constant and a reference documentation page.

Related issues

Issue Project State Summary Similarity
#400 docs: add attenuation constants reference craft-store merged Merged documentation update adding a reference page for attenuation constants. Approved by two reviewers, passed CI checks, and added 42 lines across two files.
74%