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

Update documentation and tests wrt. split headers #906

Closed
6 tasks done
nlohmann opened this issue Jan 9, 2018 · 0 comments
Closed
6 tasks done

Update documentation and tests wrt. split headers #906

nlohmann opened this issue Jan 9, 2018 · 0 comments
Assignees
Labels
documentation solution: proposed fix a fix for the issue has been proposed and waits for confirmation
Milestone

Comments

@nlohmann
Copy link
Owner

nlohmann commented Jan 9, 2018

  • The main file is singled_header/json.hpp and not src/json.hpp.
  • Document amalgamation process (see Refactor/split it #700).
  • Document forward declaration (and annotate issues).
  • Update contribution guidelines.
  • Update tests: compile suite with singled_header/json.hpp as well as src/json.hpp.
  • Add test: Check that singled_header/json.hpp is updated.
@nlohmann nlohmann added this to the Release 3.1.0 milestone Jan 9, 2018
nlohmann added a commit that referenced this issue Jan 23, 2018
- Builds and runs test cases from individual sources rather than from amalgamation.
- Checks whether amalgamation would create the same single-header file as checked in.
@nlohmann nlohmann self-assigned this Jan 23, 2018
@nlohmann nlohmann added the solution: proposed fix a fix for the issue has been proposed and waits for confirmation label Jan 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation solution: proposed fix a fix for the issue has been proposed and waits for confirmation
Projects
None yet
Development

No branches or pull requests

1 participant