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

docs: add api ref using mkdocstrings #231

Merged
merged 3 commits into from
Dec 11, 2024
Merged

Conversation

julesbertrand
Copy link
Collaborator

Description

Related Issue

Type of Change

  • 🚀 New feature (non-breaking change which adds functionality)
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🔐 Security fix
  • ⚙️ CI / CD update
  • 📚 Examples / docs / tutorials / dependencies update
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I've read the CONTRIBUTING.md guide.
  • I've updated the code style using make format-code.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in Google format for all the methods and classes that I used.
  • If my change requires a change to docs, I have updated the documentation accordingly.

Copy link

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Key issues to review

Code Smell
The URL in the docstring should be enclosed in angle brackets to render correctly in some documentation tools. Consider changing See https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform.PipelineJob`` to See <https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform.PipelineJob>.

Copy link

github-actions bot commented Dec 11, 2024

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Best practice
Enclose the URL in angle brackets to ensure it renders correctly as a clickable link

Ensure the URL in the docstring is enclosed in angle brackets to render it correctly
as a clickable link in most documentation generators.

deployer/pipeline_checks.py [149]

-to VertexAI. See `https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform.PipelineJob`
+to VertexAI. See <https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform.PipelineJob>
 
Suggestion importance[1-10]: 8

Why: Enclosing the URL in angle brackets is a best practice for documentation, ensuring it renders correctly as a clickable link in most documentation generators. This improves the readability and usability of the documentation.

8

@julesbertrand julesbertrand merged commit efef2de into develop Dec 11, 2024
11 checks passed
@julesbertrand julesbertrand deleted the docs/add-api-ref branch December 11, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant