Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Used paragraph numbers in filesystem.hpp refer to the C++17 standard #113

Closed
albert-github opened this issue Mar 22, 2021 · 3 comments
Closed
Assignees
Labels
available on master Fix is done on master branch, issue closed on next release
Milestone

Comments

@albert-github
Copy link
Contributor

Might be a bit off topic.

In the current filsystem.hpp source code we see e.g.:

// 30.10.8 class path
class GHC_FS_API_CLASS path

Here the 30.10.8 is referring to the C++17 standard paragraph, though in:

  • C++20 standard the paragraph is 29.11.7
  • C++23 draft standard the paragraph is 29.11.6

Maybe a solution would be:

  • to refer, in this case, to [fs.class.path]
  • or mention at least that the numbers are derived from the C++17 standard

similar for the other mentioned paragraph numbers.

@gulrak
Copy link
Owner

gulrak commented Mar 23, 2021

Yeah, a valid point, I'm unhappy with the now misleading paragraph numbers myself, even if I kept them in regard to the first sentence of the readme: "tightly following the C++17 standard with very few documented exceptions", but I understand that this is nothing more than a hint, and after adding C++20 support it gets kinda diffuse.

I think that switching to the identifier-like names e.g. [fs.class.path] might be the best way, and the test cases already use them as Catch2 tags to be able to select tests. Still I wouldn't schedule a release just with this, so a release will depend on other issues making a release necessary.

@gulrak gulrak self-assigned this Mar 23, 2021
@albert-github
Copy link
Contributor Author

  • I think indeed good idea to reference to the [...] tags
  • it is definitely not worth a new release as it is just a minor problem for people reading the code (and most of the time these people will know about where to find the C++17 standard).

gulrak added a commit that referenced this issue Mar 27, 2021
…++17 paragraph numbers to become more standard version agnostic
@gulrak gulrak added the available on master Fix is done on master branch, issue closed on next release label Mar 29, 2021
@gulrak gulrak added this to the v1.5.6 milestone Mar 29, 2021
@gulrak
Copy link
Owner

gulrak commented May 24, 2021

This is now part of release v1.5.6

@gulrak gulrak closed this as completed May 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
available on master Fix is done on master branch, issue closed on next release
Projects
None yet
Development

No branches or pull requests

2 participants