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

Documentation & apidoc refactor 5.0 #1062

Merged
merged 3 commits into from
Sep 29, 2021
Merged

Conversation

srknzl
Copy link
Member

@srknzl srknzl commented Sep 29, 2021

  • Remove any imdg reference, change links to point to new documentation
  • Typo fixes
  • Changes in api doc, IList is changes according to java's List documentation
  • Add check-markdown-links script to be able to easily check broken links while developing, add it to contributing.md
  • There should not be any code changes at all in this pr

closes #1051
closes #1049
closes #1048

@srknzl srknzl added this to the 5.0 milestone Sep 29, 2021
DOCUMENTATION.md Show resolved Hide resolved
DOCUMENTATION.md Outdated Show resolved Hide resolved
DOCUMENTATION.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Sep 29, 2021

Codecov Report

Merging #1062 (8da07a4) into master (663bb4f) will decrease coverage by 0.28%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1062      +/-   ##
==========================================
- Coverage   92.63%   92.34%   -0.29%     
==========================================
  Files         432      432              
  Lines       16734    16734              
  Branches     1036     1036              
==========================================
- Hits        15501    15453      -48     
- Misses        968     1012      +44     
- Partials      265      269       +4     
Impacted Files Coverage Δ
src/core/RestValue.ts 86.66% <ø> (ø)
src/core/SimpleEntryView.ts 100.00% <ø> (ø)
src/proxy/ItemListener.ts 100.00% <ø> (ø)
src/util/IndexUtil.ts 61.11% <ø> (ø)
src/network/ConnectionManager.ts 81.12% <0.00%> (-6.18%) ⬇️
src/config/ConfigBuilder.ts 93.95% <0.00%> (-2.85%) ⬇️
src/util/Util.ts 87.09% <0.00%> (-1.30%) ⬇️
src/core/HazelcastError.ts 65.55% <0.00%> (-1.12%) ⬇️
src/protocol/ErrorFactory.ts 64.96% <0.00%> (-0.73%) ⬇️
src/invocation/ClusterService.ts 93.61% <0.00%> (-0.71%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 663bb4f...8da07a4. Read the comment docs.

@srknzl srknzl merged commit 8642985 into hazelcast:master Sep 29, 2021
harunalpak pushed a commit to harunalpak/hazelcast-nodejs-client that referenced this pull request Dec 8, 2022
* Apidoc and documentation fixes for 5.0

* Review comments
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.

IList apidoc update Delete the note in docs Refactor documentation for 5.0
2 participants