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

[DOCS0-2] Document all public classes, methods and functions #2050

Merged
merged 1 commit into from May 14, 2024

Conversation

jieguangzhou
Copy link
Collaborator

Description

Related Issues

Checklist

  • Is this code covered by new or existing unit tests or integration tests?
  • Did you run make unit-testing and make integration-testing successfully?
  • Do new classes, functions, methods and parameters all have docstrings?
  • Were existing docstrings updated, if necessary?
  • Was external documentation updated, if necessary?

Additional Notes or Comments

@jieguangzhou jieguangzhou force-pushed the feat/docstings branch 7 times, most recently from 58cb325 to 94ea574 Compare May 13, 2024 13:53
@jieguangzhou jieguangzhou self-assigned this May 13, 2024
@jieguangzhou jieguangzhou linked an issue May 13, 2024 that may be closed by this pull request
8 tasks
@jieguangzhou jieguangzhou marked this pull request as ready for review May 14, 2024 07:11
- Updated docstrings for superduperdb.components

- Updated docstrings for superduperdb.base

- Updated docstrings for superduperdb.jobs

- Updated docstrings for superduperdb.server

- Updated docstrings for superduperdb.rest

- Updated docstrings for superduperdb.vector_search

- Updated docstrings for superduperdb.misc

- Updated docstrings for superduperdb.cli

- Updated docstrings for superduperdb.cdc

- Updated docstrings for superduperdb.backends

- Updated docstrings for superduperdb.ext
#"D", # pydocstyle
"D", # pydocstyle
]
ignore = [
Copy link
Collaborator

Choose a reason for hiding this comment

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

Which ruff settings are these?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@blythed blythed merged commit 840ce54 into SuperDuperDB:main May 14, 2024
3 checks passed
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.

[DOCS0-2] Document all public classes, methods and functions
2 participants