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

Adv/update serialization docs #3793

Merged
merged 13 commits into from
May 30, 2024
Merged

Adv/update serialization docs #3793

merged 13 commits into from
May 30, 2024

Conversation

antonydellavecchia
Copy link
Collaborator

Some updates to serialization documentation.

Some links from the general documentation have been added, including a link to the developer document.

Details about external implementation has been added, and an example on how polynomials are encoded.

Related to #3761

@antonydellavecchia antonydellavecchia added documentation Improvements or additions to documentation serialization labels May 24, 2024
Copy link

codecov bot commented May 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.27%. Comparing base (3ce826a) to head (32fbf9d).
Report is 8 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3793   +/-   ##
=======================================
  Coverage   81.27%   81.27%           
=======================================
  Files         580      580           
  Lines       79358    79358           
=======================================
  Hits        64502    64502           
  Misses      14856    14856           
Files Coverage Δ
src/Serialization/main.jl 85.94% <ø> (ø)

@micjoswig micjoswig added the backport 1.0.x Should be backported to the release 1.0 branch label May 26, 2024
@micjoswig
Copy link
Member

I made several small changes. Fine with me for now.

Copy link
Member

@micjoswig micjoswig left a comment

Choose a reason for hiding this comment

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

@benlorenz : I did not merge the current master into this branch, to avoid possible issues with backporting. That's also why I do not merge this branch into the master. Please take care of this.

docs/src/DeveloperDocumentation/serialization.md Outdated Show resolved Hide resolved
docs/src/DeveloperDocumentation/serialization.md Outdated Show resolved Hide resolved
docs/src/DeveloperDocumentation/serialization.md Outdated Show resolved Hide resolved
docs/src/DeveloperDocumentation/serialization.md Outdated Show resolved Hide resolved
docs/src/DeveloperDocumentation/serialization.md Outdated Show resolved Hide resolved
antonydellavecchia and others added 2 commits May 27, 2024 10:21
@benlorenz benlorenz merged commit d2ea9d7 into master May 30, 2024
30 checks passed
@benlorenz benlorenz deleted the adv/update-serialization-docs branch May 30, 2024 13:10
benlorenz pushed a commit that referenced this pull request May 30, 2024
* better linking to dev documentation

* answering johns questions

* started on intro to serialization docs

* added a couple paragraphs for external software implementations

* more paragraphs on external implementations

* remove notes that were never meant to be in final version

* fix some typos

* some rearrangements

* updating serialization docs

* fix linking error in test

* Apply suggestions from code review

Co-authored-by: Johannes Schmitt <schmitt@mathematik.uni-kl.de>

---------

Co-authored-by: Michael Joswig <joswig@math.tu-berlin.de>
Co-authored-by: Johannes Schmitt <schmitt@mathematik.uni-kl.de>
Co-authored-by: Benjamin Lorenz <benlorenz@users.noreply.github.com>
(cherry picked from commit d2ea9d7)
@benlorenz benlorenz mentioned this pull request May 30, 2024
19 tasks
@benlorenz benlorenz removed the backport 1.0.x Should be backported to the release 1.0 branch label May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation serialization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants