Skip to content

[CLIENT-4535] Replace aerospike module constants represented by inline literals with cross references#1046

Open
juliannguyen4 wants to merge 135 commits into
devfrom
CLIENT-4535-doc-replace-literals-with-cross-references-to-module-constants
Open

[CLIENT-4535] Replace aerospike module constants represented by inline literals with cross references#1046
juliannguyen4 wants to merge 135 commits into
devfrom
CLIENT-4535-doc-replace-literals-with-cross-references-to-module-constants

Conversation

@juliannguyen4

@juliannguyen4 juliannguyen4 commented Apr 26, 2026

Copy link
Copy Markdown
Collaborator

This makes sure these cross references exist so that AI (and users) can properly walk through the documentation

Manual verification

The cross references here now properly work: https://aerospike-python-client--1046.org.readthedocs.build/en/1046/aerospike_helpers.operations.html#aerospike_helpers.operations.bitwise_operations.bit_resize

@codecov-commenter

codecov-commenter commented Apr 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.46%. Comparing base (79c6dfe) to head (9f96184).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1046   +/-   ##
=======================================
  Coverage   84.46%   84.46%           
=======================================
  Files          99       99           
  Lines       14090    14090           
=======================================
  Hits        11901    11901           
  Misses       2189     2189           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…- this may make cicd check redundant in doc tests.
…the TLS test which needs to be run with a different job
…uple that contains the line number where it happened which isn't important
… run boilerplate code before each example in client.rst
…y code example. It doesn't seem possible with doctest + unittest
…ode example doesn't show the MAC address anymore.
…t the zero result codes from put and append.
@juliannguyen4 juliannguyen4 changed the base branch from dev to CLIENT-4702-doc-validate-code-examples-using-doctest-part2 June 4, 2026 22:43
@juliannguyen4 juliannguyen4 changed the base branch from CLIENT-4702-doc-validate-code-examples-using-doctest-part2 to CLIENT-4702-doc-validate-code-examples-using-doctest June 4, 2026 22:43
…nto CLIENT-4535-doc-replace-literals-with-cross-references-to-module-constants
Base automatically changed from CLIENT-4702-doc-validate-code-examples-using-doctest to dev June 5, 2026 15:15
…e-literals-with-cross-references-to-module-constants
…data: (there's no difference between the two)
@juliannguyen4 juliannguyen4 changed the title [CLIENT-4535] Replace literals with cross references for aerospike module constants [CLIENT-4535] Replace aerospike module constants represented by inline literals with cross references Jun 5, 2026
@juliannguyen4 juliannguyen4 marked this pull request as ready for review June 5, 2026 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants