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 Compact documentation [API-1564] #611

Merged
merged 2 commits into from
Mar 9, 2023

Conversation

mdumandag
Copy link
Contributor

@mdumandag mdumandag commented Mar 8, 2023

This PR updates the Compact related documentation.

  • Corrects a few stale places in the API docs
  • Removes BETA annotations from the API docs
  • Adds a documentation about the nullable-primitive interoperability

This PR does not remove the limitations section in the reference docs so that we can use the list there to make sure that the Compact works nicely with those APIs, before releasing 5.2.

closes #565
closes #582

This PR updates the Compact related documentation.

- Corrects a few stale places in the API docs
- Removes BETA annotations from the API docs
- Adds a documentation about the nullable-primitive interoperability

This PR does not remove the limitations section in the reference
docs so that we can use the list there to make sure that the
Compact works nicely with those APIs, before releasing 5.2.
@mdumandag mdumandag added this to the 5.2.0 milestone Mar 8, 2023
@mdumandag mdumandag requested a review from yuce March 8, 2023 14:44
@mdumandag mdumandag self-assigned this Mar 8, 2023
@mdumandag mdumandag changed the title Update Compact documentation Update Compact documentation [API-1564] Mar 8, 2023
@codecov-commenter
Copy link

codecov-commenter commented Mar 8, 2023

Codecov Report

Merging #611 (66d9811) into master (244084b) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #611      +/-   ##
==========================================
+ Coverage   96.46%   96.47%   +0.01%     
==========================================
  Files         357      357              
  Lines       20513    20515       +2     
==========================================
+ Hits        19787    19792       +5     
+ Misses        726      723       -3     
Impacted Files Coverage Δ
hazelcast/serialization/api.py 100.00% <100.00%> (ø)
hazelcast/serialization/compact.py 99.02% <0.00%> (-0.01%) ⬇️
hazelcast/serialization/service.py 93.11% <0.00%> (+0.11%) ⬆️
hazelcast/listener.py 90.76% <0.00%> (+0.54%) ⬆️
hazelcast/invocation.py 93.47% <0.00%> (+0.72%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@yuce yuce left a comment

Choose a reason for hiding this comment

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

Looks good, just some ideas...

@mdumandag mdumandag merged commit b2196d4 into hazelcast:master Mar 9, 2023
@mdumandag mdumandag deleted the compact-doc-update branch March 9, 2023 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment