#549

CLIENT-4159: enriched doc

Draftdmishra-aerowants to merge intofrom

Enhanced javadoc on public classes and public method that are part of IAerospikeClient Enhanced javadoc for supporting classes used by Client such as policies, errors e.t.c

Activity

11
dmishra-aero8mo ago

Please feel free to review. I’ve marked this as a draft so other stakeholders can also preview the Javadoc and assess its usefulness before getting this merged

mirzakaracicreviewed8mo ago
mirzakaracicreviewed8mo ago
mirzakaracicrequested changes8mo ago
mirzakaracic8mo ago

So there is 124 files that have been changed. I have not looked at all of the changes. I honestly don't think a pot of coffee could bring me to get through all the comments where I could dedicate enough brain bandwidth to provide useful comments. Instead I am going to give feedback based on small sample and have the AI handle the slop it has generated.

Feedback:

  • Adding code examples is great but we have examples folder as well. I take it ai will be able to sync or keep both in sync? Seems like we should provide ai instructions to at least consider the examples and make sure if there are changes doc examples that they are in sync with equivalent example in example module.
  • In some instances we have removed descriptions and just added parameters. Don't do that
  • in some instance we have reworded what was there. The problem here is that rewording is not always correct. And there are a lot of changes. Could we divide and conquer the changes? It looks like we have added about 4100 lines and removed 2100 lines. If we are going to have other PR's like this we need to be more strategic otherwise we are risking merging information that is just not correct.

I would love to get others feedback on the output here. cc: @BrianNichols @fallguy @justinlee-aerospike

github-actions[bot]8mo ago

Test Results (gnu / 8.1.0.3_2)

298 tests   277 ✅  42s ⏱️   1 suites   21 💤   1 files      0 ❌

Results for commit 62351f9e.

github-actions[bot]8mo ago

Test Results (bouncycastle / 8.1.0.3_2)

298 tests   277 ✅  42s ⏱️   1 suites   21 💤   1 files      0 ❌

Results for commit 62351f9e.

github-actions[bot]8mo ago

Test Results (gnu / 8.1.1.0_1)

298 tests   277 ✅  41s ⏱️   1 suites   21 💤   1 files      0 ❌

Results for commit 62351f9e.

github-actions[bot]8mo ago

Test Results (bouncycastle / 8.1.1.0_1)

298 tests   277 ✅  41s ⏱️   1 suites   21 💤   1 files      0 ❌

Results for commit 62351f9e.

dmishra-aeroreviewed8mo ago
dmishra-aero8mo ago

@mirzakaracic I will try to split this PR into multiple smaller PRs, each targeting a specific package or feature.

This pull request is a draft

Merging is unavailable until it is marked ready for review.