Skip to content

🔥 Added API Docs#520

Merged
mwojtyczka merged 40 commits into
mainfrom
feat/docs-autogen
Aug 17, 2025
Merged

🔥 Added API Docs#520
mwojtyczka merged 40 commits into
mainfrom
feat/docs-autogen

Conversation

@renardeinside

@renardeinside renardeinside commented Aug 13, 2025

Copy link
Copy Markdown
Contributor

Changes:

@renardeinside renardeinside requested a review from a team as a code owner August 13, 2025 10:59
@renardeinside renardeinside requested review from pratikk-databricks and removed request for a team August 13, 2025 10:59
@github-actions

github-actions Bot commented Aug 13, 2025

Copy link
Copy Markdown
Contributor

✅ 9/9 passed, 53m29s total

Running from acceptance #1811

@mwojtyczka mwojtyczka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Generally LGTM - small comments.

Pls also add info in the contributing guide that clasess/methods/funcs should have a proper docstring, otherwise they are ommited from the api docs.

Comment thread tests/e2e/test_run_demos.py Outdated
Comment thread pyproject.toml Outdated
Comment thread .gitignore Outdated
@mwojtyczka mwojtyczka requested a review from Copilot August 13, 2025 13:08

This comment was marked as outdated.

Co-authored-by: Marcin Wojtyczka <marcin.wojtyczka@databricks.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces automatic API documentation generation using pydoc-markdown to create comprehensive API documentation from Python docstrings. The changes include:

  • Converting inline docstring format from rST to Google-style (Args/Returns/Raises sections)
  • Setting up pydoc-markdown configuration for automated API doc generation
  • Minor code formatting improvements (removing empty lines)

Reviewed Changes

Copilot reviewed 44 out of 46 changed files in this pull request and generated 2 comments.

File Description
pyproject.toml Added pydoc-markdown configuration and docs environment
docs/dqx/ Updated docusaurus configuration for API docs
src/databricks/labs/dqx/ Converted docstrings from rST to Google-style format
tests/ Minor formatting fixes and docstring updates

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

Comment thread src/databricks/labs/dqx/rule.py Outdated
Comment thread src/databricks/labs/dqx/check_funcs.py

@mwojtyczka mwojtyczka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

This was referenced Aug 22, 2025
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