mapped_file documentation is incomplete
- Dominant language
- C
- Stars
- 48
- Forks
- 124
- PR merge metrics
- No merged PRs in 30d
Description
`mapped_file` documentation doesn't say:
1) if destructor closes file
2) how we should deal with IO errors (`std::copy(file.data(), ...)` can't throw, I guess?)
One should read source code to get that information:
https://stackoverflow.com/questions/26608264/what-exceptions-does-boost-mapped-file-source-throw
https://stackoverflow.com/questions/7342045/are-boost-mapped-files-raii
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the `mapped_file` source and the two linked discussions to verify whether destruction closes the file and how I/O errors are handled during operations such as `std::copy(file.data(), ...)`. Update the mapped_file documentation to answer both questions clearly, then check the resulting text against the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100