Skip to content

docs: add numpydoc guidance to contributing docs#5621

Merged
Innixma merged 1 commit intoautogluon:masterfrom
biefan:docs/add-numpydoc-contributing-4807
Mar 16, 2026
Merged

docs: add numpydoc guidance to contributing docs#5621
Innixma merged 1 commit intoautogluon:masterfrom
biefan:docs/add-numpydoc-contributing-4807

Conversation

@biefan
Copy link
Copy Markdown
Contributor

@biefan biefan commented Mar 14, 2026

Summary

  • document AutoGluon's expected NumPy docstring style in the contributing guide
  • add concise IDE setup hints for VSCode and PyCharm so contributors generate consistent docstrings

Why

Issue #4807 asks for clear contributor guidance on docstring format and practical setup tips.

Fixes #4807

@github-actions
Copy link
Copy Markdown
Contributor

Job PR-5621-18f353b is done.
Docs are uploaded to http://autogluon-staging.s3-website-us-west-2.amazonaws.com/PR-5621/18f353b/index.html

Copy link
Copy Markdown
Collaborator

@Innixma Innixma left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for the contribution!

@Innixma Innixma merged commit 16c7058 into autogluon:master Mar 16, 2026
24 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.

Add instructions for development: Docstrings, etc.

2 participants