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
ENH: Write all computation times #1197
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @larsoner ! Doc nitpicks.
I think we could add a note to the 'getting started' around this section:
sphinx-gallery/doc/getting_started.rst
Line 150 in 11812e6
After building your documentation, ``gallery_dirs`` will contain the following |
about the root sg_execution_times.rst
file?
sphinx_gallery/tests/test_full.py
Outdated
@@ -861,9 +867,9 @@ def _rerun( | |||
# - auto_examples/index | |||
# - auto_examples/plot_numpy_matplotlib | |||
if how == "modify": | |||
n_ch = "[3-7]" | |||
n_ch = "[3-9]" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we amend the comment above to add the global execution file to "Ones that can change on stale:". Also I'm lost, why is this not +1 (8) ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not totally sure why I needed the extra one here but I also think it's okay to be lenient
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... actually updating the comment made it clear I think, pushing
I went to fix the unrelated |
All green! |
Could we add to our release notes that we are dropping support for 3.7? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for fixing the CI failure!
# memory usage reported ends up being the same. | ||
# | ||
# Modifying an example then adds these two: | ||
# - auto_examples/index | ||
# - auto_examples/plot_numpy_matplotlib | ||
if how == "modify": | ||
n_ch = "[3-7]" | ||
n_ch = "([3-9]|10)" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not [3-10]
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had that originally! But it's bad regex :) [3-9]
is a character range. If you write [3-10]
regex complains because it sees this as "the range of characters from 3-1, and also the character zero" -- and the range 3-1
doesn't make sense (it would need to be 1-3 and it's also not what we want). So by doing ([3-9]|10)
it will match any single digit between 3 and 9, or the literal string 10, which is what we want.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah yes of course, thanks!
Co-authored-by: Lucy Liu <jliu176@gmail.com>
I committed your tweaks so I'll mark for merge, thanks for the quick review @lucyleeow |
… to version 0.15.0 v0.15.0 ------- Support for Python 3.7 dropped in this release. Requirement is now Python >=3.8. Pillow added as a dependency. **Implemented enhancements:** - ENH: Improve logging visibility of errors and filenames `#1225 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1225>`__ (`larsoner <https://github.com/larsoner>`__) - ENH: Improve API usage graph `#1203 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1203>`__ (`larsoner <https://github.com/larsoner>`__) - ENH: Always write sg_execution_times and make DataTable `#1198 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1198>`__ (`larsoner <https://github.com/larsoner>`__) - ENH: Write all computation times `#1197 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1197>`__ (`larsoner <https://github.com/larsoner>`__) - ENH: Support source files in any language `#1192 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1192>`__ (`speth <https://github.com/speth>`__) - FEA Add examples recommender system `#1125 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1125>`__ (`ArturoAmorQ <https://github.com/ArturoAmorQ>`__) (NEWS truncated at 15 lines)
For a while I've wanted a full listing of example computation times. This PR writes them to the
src_dir
root assg_execution_times.html
, which I think is hopefully safe enough.Snuck in some cleanups of
pytest.mark.parametrize
so our test names can be a bit shorter in the terminal, too.