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

[docs] add C++17 dependency, fix markup issues #371

Open
cz4rs opened this issue Sep 25, 2024 · 0 comments
Open

[docs] add C++17 dependency, fix markup issues #371

cz4rs opened this issue Sep 25, 2024 · 0 comments

Comments

@cz4rs
Copy link
Contributor

cz4rs commented Sep 25, 2024

std::optional is documented as being added in C++17, while Magistrate documentation says it's a C++14 library.

Fortunately, it doesn't look like std::optional is actually used anywhere in here, so this inclusion should just be dropped.

Also, maybe that line of the documentation is out of date, in which case, please open an issue. Additionally, I see two more issues of documentation markup not being rendered properly, which may represent additional issues(s):

  • \checkpoint
  • @m_class{m-note m-dim}

Originally posted by @PhilMiller in #345 (comment)

TODO:

  • magistrate requires C++17, update the docs to reflect that.
  • Take a look at the rendering issues mentioned by Phil and fix them or open a separate issue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant