docs: function names in the design notes and specs are stale
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- go
- Domain
- documentation
Research direction
Read the listed occurrences in design/implementation.md, spec/rename_guarded.fsl, and spec/naming_rules.fsl. Update the stale names to the replacements in the issue, leaving the spec behavior unchanged. Done when those references match the Go code and the specs still verify.
Written by the indexing model from the issue text.
Description
The following names no longer exist in the analyzer's Go code (grep -w):
| Old name | Now | Where it still appears |
|---|---|---|
renameSafe (it survives only in shrink) |
safeToRename |
design/implementation.md, spec/rename_guarded.fsl |
fileScopesBind |
renameBoundByImport |
design/implementation.md, spec/rename_guarded.fsl |
hasUnseenTests |
unseen().all |
design/implementation.md |
directiveFix, startsLine |
directiveInsertionFix, insertionAtLineStart |
design/implementation.md, spec/naming_rules.fsl |
The places are design/implementation.md lines 356, 390, 394, 400, 408 and 472, spec/rename_guarded.fsl lines 6–10 and 66, and spec/naming_rules.fsl line 48.
Suggested fix
Rename them in the docs. Only the spec comments change, so the specs still verify.
- Dominant language
- Go
- Stars
- 42
- Forks
- 1
- Avg merge
- 1h 18m
- Merged PRs (30d)
- 94
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 mpyw/declscope
-
bug P3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mpyw/declscope#262 · 1 comment ·
Maintainers usually reply within 1 day
-
documentation P3
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day
-
bug P2
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
bug P2
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
docker/sbx-releases#737 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
area/manager needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
kyma-project/telemetry-manager#3922 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
JakeChampion/lang#12965 ·
Maintainers usually reply within 1 day
-
hacktoberfest priority: low skill: good first issue status: ready for dev
Difficulty 2/5 1-3 hours Newbie friendliness 89/100
hyperledger-labs/fabric-smart-client#2218 ·
Maintainers usually reply within 1 day