jacebrowning / jacebrowning/datafiles
Preserve comments on list items
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- Python
- Stars
- 213
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 5
Description
This test demonstrates the expected functionality:
https://github.com/jacebrowning/datafiles/blob/a51507b0d165cbc0d0e669ea702d55ea207f27ea/tests/test_saving.py#L408-L450
This appears to be an issue with the YAML library: https://sourceforge.net/p/ruamel-yaml/tickets/318/
Contributor 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.
Research direction
Start with tests/test_saving.py lines 408-450 and run the linked test to confirm the expected preservation of comments on list items. Trace the saving path for list data and review the linked ruamel-yaml ticket for the suspected library limitation. Done means the referenced test passes without losing those comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100