More utils doc #25457
More utils doc #25457
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
setup.py
Outdated
|
|
||
| 6. Add a tag in git to mark the release: "git tag v<VERSION> -m 'Adds tag v<VERSION> for pypi' " | ||
| 5. Add a tag in git to mark the release: "git tag v<VERSION> -m 'Adds tag v<VERSION> for pypi' " |
There was a problem hiding this comment.
this should be from the release branch, right? If so, the doc doesn't make this (super) clear.
utils/check_table.py
Outdated
| @@ -12,11 +12,30 @@ | |||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
| """ | |||
| Utility that checks the big table in the index.md of the doc and potentially updates it. | |||
There was a problem hiding this comment.
Would love the full (relative) path if you are OK with this suggestion.
utils/check_task_guides.py
Outdated
| @@ -12,7 +12,26 @@ | |||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
| """ | |||
| Utility that checks the list of models that can be used for each in task (as defined in the task-specific pages of the | |||
There was a problem hiding this comment.
the list of models that can be used for each in task (as defined in the task-specific pages of the doc)
might be more clear if we mention tip, like
the list of models used in the tips in the task-specific pages of the doc
utils/release.py
Outdated
| PATH_TO_EXAMPLES = "examples/" | ||
| # This maps a type of file to the patter to look for when searching where the version is defined, as well as the |
| @@ -12,41 +12,84 @@ | |||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
| """ | |||
| Utility that prepares the repository for releases (or patches) by updating all versions in the relevant places. It | |||
| also performs some post-release cleanup, by updating the links in the main README to respective model doc pages (from | |||
There was a problem hiding this comment.
when I read this, I am thinking this is only for the post-release. But after reading later stuff below, it seems to me the changes will (and should) be on the release branch and the main branch (after the release).
I am not strong for a change here, but if you happen to have a better wording, it would be nice.
utils/sort_auto_mappings.py
Outdated
| @@ -65,11 +94,16 @@ def sort_auto_mapping(fname, overwrite: bool = False): | |||
| if overwrite: | |||
| with open(fname, "w", encoding="utf-8") as f: | |||
| f.write("\n".join(new_lines)) | |||
| elif "\n".join(new_lines) != content: | |||
| return True | |||
| return "\n".join(new_lines) != content | |||
There was a problem hiding this comment.
this change requires a change in the docstring for Returns
utils/sort_auto_mappings.py
Outdated
| @@ -46,7 +45,7 @@ | |||
| _re_identifier = re.compile(r'\s*\(\s*"(\S[^"]+)"') | |||
|
|
|||
|
|
|||
| def sort_auto_mapping(fname: str, overwrite: bool = False) -> Optional[bool]: | |||
| def sort_auto_mapping(fname: str, overwrite: bool = False) -> bool: | |||
There was a problem hiding this comment.
I mean the following, yes, the return signature should be changed too (good catch!)
Returns:
`Optional[bool]`: Returns `None` if `overwrite=True`. Otherwise returns `True` if the file has an auto-mapping
improperly sorted, `False` if the file is okay.
There was a problem hiding this comment.
Actually put back the optional and fixed the return so it's correct.
* Document and clean more utils. * More documentation and fixes * Switch to Lysandre's token * Address review comments * Actually put else
What does this PR do?
This continues the work of cleaning up the scripts used for quality checks, which comes with a couple of fixes mainly:
setup.pyweren't necessarily up to date, so fixing those.ImageProcessors.