Skip to content

Add Lint/DocumentationAdmonition rule #380

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
Merged
merged 6 commits into from
Nov 6, 2023
Merged

Add Lint/DocumentationAdmonition rule #380

merged 6 commits into from
Nov 6, 2023

Conversation

Sija
Copy link
Member

@Sija Sija commented Jun 15, 2023

No description provided.

@Sija Sija added the rule label Jun 15, 2023
@Sija Sija added this to the 1.5.0 milestone Jun 15, 2023
@Sija Sija requested a review from veelenga June 15, 2023 01:15
@Sija Sija self-assigned this Jun 15, 2023
veelenga
veelenga reviewed Jun 15, 2023
View reviewed changes
Copy link
Member

@veelenga veelenga left a comment

Choose a reason for hiding this comment

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

Looking good to me. I would extend the top-level doc explaining the cases when:

  1. there is a date
  2. there is a date + time
  3. there is an admonition error. Maybe the error message could state what the op must do to fix the error.

@Sija Sija modified the milestones: 1.5.0, 1.6.0 Oct 6, 2023
@Sija Sija force-pushed the add-documentation-admonition-rule branch 5 times, most recently from b619a33 to a8faa24 Compare November 6, 2023 07:28
@Sija Sija marked this pull request as ready for review November 6, 2023 07:56
@Sija Sija requested a review from veelenga November 6, 2023 07:56
veelenga
veelenga approved these changes Nov 6, 2023
View reviewed changes
Copy link
Member

@veelenga veelenga left a comment

Choose a reason for hiding this comment

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

LGTM 👏

@Sija Sija force-pushed the add-documentation-admonition-rule branch from ba15ce1 to 1fccbfc Compare November 6, 2023 15:59
@Sija Sija merged commit 9f6615b into master Nov 6, 2023
@Sija Sija deleted the add-documentation-admonition-rule branch November 6, 2023 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@veelenga veelenga veelenga approved these changes

+1 more reviewer

@straight-shoota straight-shoota straight-shoota left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@Sija Sija

Labels
rule
Projects
None yet
Milestone
1.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@Sija @straight-shoota @veelenga