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

fix(docs): Don't convert doc attributes to doc comments on format. #351

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Nov 7, 2024

Description

In Poem, doc attributes prevent Poem from picking up the doc comment, and it then reverts to the documentation in the underlying type.
This is very useful for enforcing consistent documentation.
So, prevent doc attributes being converted to actual doc comments.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj enabled auto-merge (squash) November 7, 2024 05:46
@stevenj stevenj self-assigned this Nov 7, 2024
@stevenj stevenj added the review me PR is ready for review label Nov 7, 2024
@stevenj stevenj merged commit f746f97 into master Nov 7, 2024
42 of 43 checks passed
@stevenj stevenj deleted the fix/no-normalize-doc-attributes branch November 7, 2024 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review me PR is ready for review
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants