[{o,i}stream.formatted] inconsistent in use of Elements
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
The itemdescrs of the formatted output operations use Effects: and Returns: elements as expected, but the corresponding input operations don't use any Elements at all, even though they probably can and should.
I realise iostreams has a lot of history, and we don't necessarily want to do a complete modernisation revision of the entire clause, but maybe this specific issue is something we can fix.
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
Start with the [{o,i}stream.formatted] input and output operation descriptions in the iostreams clause, comparing the existing Effects: and Returns: Elements. Update the input operations to use the appropriate Elements and confirm that their item descriptions are consistent with the output operations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100