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.

Sign up for GitHub

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

Jump to bottom

documentation fixes, add config docs #2225

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

documentation fixes, add config docs #2225

wants to merge 1 commit into from
+95 −40

Conversation

jamesmunro
Copy link
Collaborator

@jamesmunro jamesmunro commented Mar 7, 2025 •
edited
Loading

What does this implement or fix?

  • Fix documentation issues and bad links.
  • Expose set_config_int and get_config_int on arcticdb.config.
  • Add config API docs.

Checklist

Checklist for code changes...
  • Have you updated the relevant docstrings, documentation and copyright notice?
  • Is this contribution tested against all ArcticDB's features?
  • Do all exceptions introduced raise appropriate error messages?
  • Are API changes highlighted in the PR description?
  • Is the PR labelled as enhancement or bug so it appears in autogenerated release notes?

@jamesmunro jamesmunro added the documentation Improvements or additions to documentation label Mar 7, 2025
@jamesmunro jamesmunro added the patch Small change, should increase patch version label Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ognyanstoimenov ognyanstoimenov Awaiting requested review from ognyanstoimenov

@alexowens90 alexowens90 Awaiting requested review from alexowens90 alexowens90 will be requested when the pull request is marked ready for review alexowens90 is a code owner

@willdealtry willdealtry Awaiting requested review from willdealtry willdealtry will be requested when the pull request is marked ready for review willdealtry is a code owner

@poodlewars poodlewars Awaiting requested review from poodlewars poodlewars will be requested when the pull request is marked ready for review poodlewars is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation patch Small change, should increase patch version
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jamesmunro