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

chore: update script for generating README #12689

Merged
merged 10 commits into from
May 14, 2024

Conversation

ohmayr
Copy link
Contributor

@ohmayr ohmayr commented May 13, 2024

Towards #11147
Towards #12679 🦕

@ohmayr ohmayr requested a review from a team as a code owner May 13, 2024 18:20
@parthea parthea changed the title fix: update script for generating README chore: update script for generating README May 13, 2024
Copy link
Contributor

@vchudnov-g vchudnov-g 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. Some minor comments. Look particularly at my suggestion about defining a Python dataclass for clarity.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
scripts/updateapilist.py Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Show resolved Hide resolved
scripts/updateapilist.py Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
Copy link
Contributor

@vchudnov-g vchudnov-g left a comment

Choose a reason for hiding this comment

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

Wanted to expand on a point: the Extractor is either a data class that does not care whether it's a split repo or not (it just blindly uses the values decided upon and given by its caller); or it's a regular class and it decides and sets those values internally. We shouldn't mix the two models, IMO.

scripts/updateapilist.py Outdated Show resolved Hide resolved
scripts/updateapilist.py Show resolved Hide resolved
scripts/updateapilist.py Show resolved Hide resolved
scripts/updateapilist.py Outdated Show resolved Hide resolved
Copy link
Contributor

@vchudnov-g vchudnov-g 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 doing this!

@ohmayr ohmayr added this pull request to the merge queue May 14, 2024
@parthea parthea removed this pull request from the merge queue due to the queue being cleared May 14, 2024
@parthea parthea merged commit b2853c6 into main May 14, 2024
18 checks passed
@parthea parthea deleted the fix-script-for-updating-API-list-in-README branch May 14, 2024 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants