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

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

Closed
8 tasks
Tracked by #1756
blythed opened this issue Mar 11, 2024 · 1 comment · Fixed by #2035 or #2050
Closed
8 tasks
Tracked by #1756

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

blythed opened this issue Mar 11, 2024 · 1 comment · Fixed by #2035 or #2050
Assignees
@jieguangzhou

Comments

@blythed
Copy link
Collaborator

blythed commented Mar 11, 2024 •
edited

Use this utility: https://github.com/SuperDuperDB/superduperdb/blob/main/test/unittest/test_docstrings.py

TODO:

  • Add a utility to restrict the checkers to the below places.

Prelaunch:

  • base.datalayer.Datalayer
  • components.component.Component
  • components.model.*
  • components.datatype.*
  • components.vector_index.VectorIndex
  • components.schema.Schema
  • components.metric.Metric
@blythed blythed mentioned this issue Mar 11, 2024
Closed
22 tasks
@blythed blythed assigned kartik4949 and unassigned blythed and jieguangzhou Apr 26, 2024
@kartik4949 kartik4949 mentioned this issue May 4, 2024
Merged
5 tasks
@blythed
Copy link
Collaborator Author

blythed commented May 10, 2024

@jieguangzhou to increase coverage and doc-string quality.

@blythed blythed reopened this May 10, 2024
@jieguangzhou jieguangzhou linked a pull request May 13, 2024 that will close this issue
[DOCS0-2] Document all public classes, methods and functions #2050
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jieguangzhou jieguangzhou

Labels
None yet
Projects
SuperDuperDB-OSS
Status: Done
Milestone
No milestone
5 participants
@anitaokoh @blythed @jieguangzhou @kartik4949 @Lalith-Sagar-Devagudi