🌐 AI搜索 & 代理 主页
Skip to content

Conversation

@anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 16, 2025

Remove unnecessary info snippets e.g. re: fractal rendering (this isn't a table for font designers); merge Type 42 entry together with TrueType (they are essentially the same technology).

PR summary

PR checklist

@github-actions github-actions bot added Documentation: user guide files in galleries/users_explain or doc/users and removed topic: text/fonts labels Sep 16, 2025
@tacaswell tacaswell added this to the v3.11.0 milestone Sep 17, 2025
@tacaswell
Copy link
Member

👍 modulo placating the linter .

I think we should go with adding a # noqa: E501 after the closing """ or exempt this whole file from the line length checks rather than forcing the table to fit.

@story645
Copy link
Member

rather than forcing the table to fit.

Might be worth switching the table to a list-table since most of the sentences are long?

@anntzer
Copy link
Contributor Author

anntzer commented Sep 17, 2025

It would be nice if sphinx-gallery authorized this file to just be a .rst (which would get properly highlighted in the editor and not be subject to irrelevant python linting rules. (@timhoffm IIRC you interact a bit with the s-g team, perhaps you have an opinion there?)
In any case I'll just noqa this file for now.

Remove unnecessary info snippets e.g. re: fractal rendering (this isn't
a table for font designers); merge Type 42 entry together with TrueType
(they are essentially the same technology).
@timhoffm
Copy link
Member

timhoffm commented Sep 18, 2025

It would be nice if sphinx-gallery authorized this file to just be a .rst (which would get properly highlighted in the editor and not be subject to irrelevant python linting rules. (@timhoffm IIRC you interact a bit with the s-g team, perhaps you have an opinion there?)

As of today sphinx-gallery does not support this (see https://sphinx-gallery.github.io/stable/syntax.html#plain-rest-examples). I'm not clear whether that's a fundamental design decision or whether it's just not implemented. Technically, that would be perfectly possible. It just slightly complicates the processing in that you have to skip the right parts of the example build.

What you could try as a workaround is making a placeholder .py file and include an .rst

"""
.. include:: actual_content.rst
"""

May need some fiddling to get the path to the rst file right.

Alternatively, just include the table as a separate .rst file or use a list table as suggested by @story645.

@timhoffm timhoffm merged commit 1377f24 into matplotlib:main Sep 18, 2025
22 checks passed
@anntzer anntzer deleted the fd branch September 18, 2025 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: user guide files in galleries/users_explain or doc/users Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants