Skip to content

[Sphinx Extension] Add check for required guideline fields #45

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 5 commits into from
Apr 29, 2025
Merged

[Sphinx Extension] Add check for required guideline fields #45

merged 5 commits into from
Apr 29, 2025

Conversation

@x0rw
Copy link
Contributor

@x0rw x0rw commented Apr 21, 2025

Add checks for required guideline fields

  • Configurable via required_guideline_fields in src/conf.py
  • New guidelines_checks.py for more fine-grained future checks

Resolves #42.

@x0rw x0rw closed this Apr 21, 2025
@x0rw x0rw force-pushed the feature/required-fields-check branch from ba5272e to bf33bea Compare April 21, 2025 20:45
@x0rw x0rw reopened this Apr 21, 2025
x0rw
x0rw commented Apr 21, 2025
View reviewed changes
@PLeVasseur
Copy link
Contributor

Friendly ping to @x0rw -- is this ready for review?

@x0rw
Copy link
Contributor Author

x0rw commented Apr 29, 2025

Friendly ping to @x0rw -- is this ready for review?

Hey @PLeVasseur, this is ready for review.

PLeVasseur
PLeVasseur reviewed Apr 29, 2025
View reviewed changes
Copy link
Contributor

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Thanks @x0rw -- can you check the comment I left? Seems maybe some debug code was left in?

PLeVasseur
PLeVasseur reviewed Apr 29, 2025
View reviewed changes
Copy link
Contributor

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

A couple of more things. Also -- could you intentionally remove a required field and show the build fail?

That will give some confidence that this functionality works.

Appreciate it!

@x0rw
Copy link
Contributor Author

x0rw commented Apr 29, 2025 •
edited
Loading

A couple of more things. Also -- could you intentionally remove a required field and show the build fail?

That will give some confidence that this functionality works.

Appreciate it!

Alright, the next commit should fail the build pipeline.
No worries.

@x0rw
test: intentionally break build to verify CI failure
d591d41 
this commit removes tags, decidability, scope fields from types-and-traits.rst
@x0rw
Copy link
Contributor Author

x0rw commented Apr 29, 2025

it failed successfully.

PLeVasseur
PLeVasseur reviewed Apr 29, 2025
View reviewed changes
Copy link
Contributor

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Cool, thanks for showing it breaks. Please restore and then I'll approve!

PLeVasseur
PLeVasseur approved these changes Apr 29, 2025
View reviewed changes
Copy link
Contributor

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Thanks for tackling this @x0rw!

@PLeVasseur PLeVasseur added this pull request to the merge queue Apr 29, 2025
Merged via the queue into rustfoundation:main with commit 413cb79 Apr 29, 2025
2 checks passed
@x0rw x0rw mentioned this pull request Apr 29, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@PLeVasseur PLeVasseur PLeVasseur approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Make all required options on a guideline fail the build if not present

2 participants

@x0rw @PLeVasseur