Skip to content

omitir warnings de 'availability' y 'wasm-notavail' #1847

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

Merged
merged 1 commit into from
Oct 26, 2022

Conversation

cmaureir
Copy link
Collaborator

@cmaureir cmaureir commented Oct 26, 2022

edit: including explanation

the whole story on the 'availability' warnings are that there is a .. availability:: command in the cpython docs that include, in some cases, stuff from the 'wasm-availability' file. So we have references "within" the 'availabiliy' command.

as you can see, the entry has no mention of WASM or wahtsover in some entries, like "Unix, Windows",
but still will generate the following warning:

cpython/Doc/library/os.rst:: WARNING: inconsistent term references in translated message. original: [':ref:`Availability <availability>`', ':ref:`wasm-availability`'], translated: [':ref:`Disponibilidad <availability>`']

The reason that due to the internal reference to 'wasm-availability' , even in cases like this entry, where it's only Unix and Windows, for example:

https://docs.python.org/3.11/library/os.html?highlight=os#os.getenv

it generates the reference to the 'Availability' page, which inside has the 'wasm-availability' inside:

https://docs.python.org/3.11/library/intro.html#availability

Additionally, the wasm-notavail file is excluded to avoid the warning related to the file not being inclued in any index. We could have add :orphan: to the file inside cpython but we do it via the exclude patterns to avoid touching files on the submodule.

@cmaureir cmaureir added the hacktoberfest-accepted mantainer-approved contribution to hacktoberfest label Oct 26, 2022
@cmaureir cmaureir changed the title omitir warnings de 'availability' omitir warnings de 'availability' y 'wasm-notavail' Oct 26, 2022
@cmaureir cmaureir merged commit 0ea8d36 into 3.11 Oct 26, 2022
@cmaureir
Copy link
Collaborator Author

Gracias por el review @raulcd 💯

@cmaureir
Copy link
Collaborator Author

Mencionando #1845 para que esté enlazado ese issue con este pr

@cmaureir cmaureir deleted the skip_warnings_wasm branch March 3, 2023 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted mantainer-approved contribution to hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants