theupdateframework / theupdateframework/specification
Clarify the preorder DFS
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 405
- Forks
- 59
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 1
Description
Per the discussion in #150, it's not clear in the description of the DFS that each of the steps below 'Perform a pre-order depth-first search' must be done on each iteration. This might be more clear with another layer of nesting in the description.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Read the discussion in #150, then locate the DFS description in the specification. Clarify the wording with an additional nesting level so it explicitly shows that every listed step is performed on each iteration; the work is done when that ambiguity is removed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100