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 method docs #23

Merged
merged 5 commits into from
Aug 25, 2022
Merged

docs: add method docs #23

merged 5 commits into from
Aug 25, 2022

Conversation

dtdang
Copy link
Contributor

@dtdang dtdang commented Aug 10, 2022

What I did

Add files necessary to generate method docs for ape-alchemy plugin
#24

How I did it

Added missing doc strings that were not already defined in ape core.

How to verify it

Verify the docs make sense that were added

Checklist

  • Passes all linting checks (pre-commit and CI jobs)
  • New test cases have been added and are passing
  • Documentation has been updated
  • PR title follows Conventional Commit standard (will be automatically included in the changelog)

@dtdang dtdang requested a review from antazoey August 10, 2022 20:57
Copy link
Member

@antazoey antazoey left a comment

Choose a reason for hiding this comment

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

Looking great!
Here is some feedback.

.github/workflows/docs.yaml Outdated Show resolved Hide resolved
ape_alchemy/providers.py Outdated Show resolved Hide resolved
ape_alchemy/providers.py Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
ape_alchemy/providers.py Outdated Show resolved Hide resolved
Copy link
Member

@antazoey antazoey left a comment

Choose a reason for hiding this comment

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

Couple small things but looks great

.github/workflows/docs.yaml Outdated Show resolved Hide resolved
ape_alchemy/providers.py Outdated Show resolved Hide resolved
@NotPeopling2day NotPeopling2day merged commit c3ccc07 into main Aug 25, 2022
@NotPeopling2day NotPeopling2day deleted the docs/dtdang/docstring branch August 25, 2022 14:43
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