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

Complete documentation for 3.11.0 #3464

Merged
merged 25 commits into from
May 17, 2022
Merged

Complete documentation for 3.11.0 #3464

merged 25 commits into from
May 17, 2022

Conversation

nlohmann
Copy link
Owner

@nlohmann nlohmann commented May 1, 2022

  • BJData
  • contributors for 3.11.0

Further changes:

  • removed deprecated BJData functions
  • removed example for deprecated iterator_wrapper function
  • added a lot more examples

Todo:

@nlohmann nlohmann self-assigned this May 1, 2022
@nlohmann nlohmann marked this pull request as draft May 1, 2022 13:11
@nlohmann nlohmann added the aspect: binary formats BSON, CBOR, MessagePack, UBJSON label May 1, 2022
@nlohmann nlohmann changed the title Overwork documentation Complete documentation for 3.11.0 May 1, 2022
@coveralls
Copy link

coveralls commented May 1, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling 5fe1424 on documentation into 0c698b7 on develop.

Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

docs/mkdocs/docs/home/exceptions.md Outdated Show resolved Hide resolved
fangq added a commit to NeuroJSON/json that referenced this pull request May 12, 2022
@fangq
Copy link
Contributor

fangq commented May 12, 2022

@nlohmann, let me know if the above commit looks ok to you: NeuroJSON@d2238e5
or
https://github.com/NeuroJSON/json/blob/issue3464/docs/mkdocs/docs/features/binary_formats/bjdata.md

not sure how to do a PR to a PR, feel free to copy the bjdata.md file directly to your local branch.

@falbrechtskirchinger
Copy link
Contributor

@nlohmann, let me know if the above commit looks ok to you: NeuroJSON@d2238e5 or https://github.com/NeuroJSON/json/blob/issue3464/docs/mkdocs/docs/features/binary_formats/bjdata.md

not sure how to do a PR to a PR, feel free to copy the bjdata.md file directly to your local branch.

I think when creating a PR you can select a different destination branch than develop. This PR is being developed in the documentation branch (see line below the PR title).

@fangq
Copy link
Contributor

fangq commented May 12, 2022

I think when creating a PR you can select a different destination branch than develop. This PR is being developed in the documentation branch (see line below the PR title).

thanks @falbrechtskirchinger, new PR against documentation branch at #3493

* update bjdata.md for #3464

* Minor edit

* Fix URL typo

* Add info on demoting ND array to a 1-D optimized array when singleton dimension
@nlohmann nlohmann marked this pull request as ready for review May 17, 2022 10:33
@nlohmann nlohmann added this to the Release 3.11.0 milestone May 17, 2022
@nlohmann nlohmann added release item: 🔨 further change and removed aspect: binary formats BSON, CBOR, MessagePack, UBJSON labels May 17, 2022
@nlohmann nlohmann merged commit 6a73920 into develop May 17, 2022
@nlohmann nlohmann deleted the documentation branch May 17, 2022 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants