Correct the documented phi-function recurrence join
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Read the module introduction in src/solprop/backends/exponential.py alongside PHI_JOIN = 3.0 and its existing rationale. Correct the three overview inequalities to match the join at 3 while retaining the derivation and qualification rationale. Done means the overview and implementation agree and the changed-file spelling and documentation checks pass.
Written by the indexing model from the issue text.
Description
What happens
The module introduction in src/solprop/backends/exponential.py describes a near/far split at |x| = 8, while the implementation's PHI_JOIN is 3.0 and its detailed rationale describes the split at 3. The near-series and far-recurrence inequalities therefore disagree within the same file.
Why it matters
The module is the numerical reference for other backends. Its stale overview can cause an implementing backend to use a different numerical branch domain.
Reproduction
Read, not a numerical run: compare the introductory near/away bullets with PHI_JOIN = 3.0 and its docstring in the inspected source. The constant and detailed rationale agree with the implemented split; the introduction does not.
Context
Found during SEP 48 implementation #611, tracking #608. This is a documentation correction, with no proposed change to coefficients, arithmetic or defaults.
To do
- Correct all three overview inequalities to match
PHI_JOIN. - Retain the existing derivation and qualification rationale.
Done when
The overview and implementation consistently describe the join at 3; changed-file spelling and documentation checks pass.
- Dominant language
- Python
- Stars
- 3
- Forks
- 3
- Avg merge
- 8h 28m
- Merged PRs (30d)
- 176
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from LupoLab/solprop
-
bug
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
documentation priority: medium
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
documentation priority: high
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
documentation good first issue priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area: native priority: low testing
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
Similar issues
-
bug triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
mealie-recipes/mealie#9117 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
freelawproject/courtlistener#8406 ·
Maintainers usually reply within 2 days
-
good first issue help wanted level 1 wocs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
GianlucaBave/murmury#49 ·
Maintainers usually reply within 1 day
-
regression skipped skipped_bmg
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
intel/torch-xpu-ops#6142 · 1 comment ·
Maintainers usually reply within 2 days
-
good first issue help wanted python up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 85/100
andrewsiah/agentswarm-data-tasks#122 ·
Maintainers usually reply within 1 day