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

Use transdoc to keep module docstring in sync with readme #21

Open
MaddyGuthridge opened this issue Nov 25, 2023 · 1 comment
Open

Use transdoc to keep module docstring in sync with readme #21

MaddyGuthridge opened this issue Nov 25, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@MaddyGuthridge
Copy link
Contributor

MaddyGuthridge commented Nov 25, 2023 •
edited
Loading

PyHTML's module docstring is identical to its README. As such, it'd be neat to build said docstring by copying in the readme at build time.
@MaddyGuthridge MaddyGuthridge added the enhancement New feature or request label Nov 25, 2023
@MaddyGuthridge
Copy link
Contributor Author

Could also use transdoc for this instead, and use a build hook in Poetry.

@MaddyGuthridge MaddyGuthridge changed the title Create a pre-commit hook to ensure module docstring stays in sync Use transdoc to keep module docstring in sync with readme May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MaddyGuthridge