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

Support option group documentation #7593

Merged
merged 1 commit into from
Sep 22, 2023
Merged

Support option group documentation #7593

merged 1 commit into from
Sep 22, 2023

Conversation

MichaReiser
Copy link
Member

@MichaReiser MichaReiser commented Sep 22, 2023 •
edited
Loading

Summary

This PR adds support for documenting types implementing OptionsMetadata.

I think we'll want to add a short explanation to the lint section that it is experimental.

Test Plan

Generated the options.md and the documentation for format shows up.

image

This was referenced Sep 22, 2023
Merged
Merged
@MichaReiser
Copy link
Member Author

MichaReiser commented Sep 22, 2023 •
edited
Loading

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@MichaReiser MichaReiser mentioned this pull request Sep 22, 2023
Merged
@MichaReiser MichaReiser force-pushed the 09-22-Support_option_group_documentation branch from d4e8206 to 2292d54 Compare September 22, 2023 09:23
@MichaReiser MichaReiser added the documentation Improvements or additions to documentation label Sep 22, 2023
@MichaReiser MichaReiser marked this pull request as ready for review September 22, 2023 09:25
@MichaReiser MichaReiser force-pushed the 09-22-Support_option_group_documentation branch from 2292d54 to cad18a2 Compare September 22, 2023 11:26
@MichaReiser MichaReiser force-pushed the refactor-options branch 2 times, most recently from 2ee6747 to 0fe9465 Compare September 22, 2023 15:41
@MichaReiser MichaReiser force-pushed the 09-22-Support_option_group_documentation branch from cad18a2 to 5f708aa Compare September 22, 2023 15:41
@MichaReiser MichaReiser mentioned this pull request Sep 22, 2023
Merged
@MichaReiser MichaReiser force-pushed the 09-22-Support_option_group_documentation branch from 5f708aa to 3df98d8 Compare September 22, 2023 15:49
charliermarsh
charliermarsh approved these changes Sep 22, 2023
View reviewed changes
Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

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

That's awesome.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 22, 2023 •
edited
Loading

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Base automatically changed from refactor-options to main September 22, 2023 16:20
@MichaReiser MichaReiser force-pushed the 09-22-Support_option_group_documentation branch from 3df98d8 to 67dacc8 Compare September 22, 2023 16:20
@MichaReiser MichaReiser enabled auto-merge (squash) September 22, 2023 16:25
@codspeed-hq
Copy link

codspeed-hq bot commented Sep 22, 2023

CodSpeed Performance Report

Merging #7593 will improve performances by 2.32%

Comparing 09-22-Support_option_group_documentation (67dacc8) with main (2ecf597)

Summary

⚡ 1 improvements
✅ 24 untouched benchmarks

Benchmarks breakdown

Benchmark main 09-22-Support_option_group_documentation Change
⚡ linter/default-rules[large/dataset.py] 94.1 ms 92 ms +2.32%

@MichaReiser MichaReiser merged commit 01843af into main Sep 22, 2023
16 checks passed
@MichaReiser MichaReiser deleted the 09-22-Support_option_group_documentation branch September 22, 2023 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charliermarsh charliermarsh charliermarsh approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MichaReiser @charliermarsh