DOC simpler block delimitation in sphinx-gallery examples #17068

rth · 2020-04-28T09:00:35Z

On Linux,

find examples/ -name "*.py" -exec sed -i 's/#\s*#\{5,100\}/# %%/g' {} +

(the syntax is slightly different for sed version installed on MacOS cf SO)

cc @thomasjpfan

adrinjalali · 2020-04-28T09:48:41Z

Nice!

NicolasHug

IMHO, the current version makes the sections more obvious, especially in text mode. But why not

rth · 2020-04-28T12:16:59Z

CI failure is unrelated due to fetch_california_housing network error.

thomasjpfan · 2020-04-28T15:05:54Z

Some of these do change the formatting. For example: this pr and master.

NicolasHug · 2020-04-29T12:22:58Z

Does anybody have a strong feeling about getting this in?

adrinjalali · 2020-04-29T12:28:25Z

Some IDEs such as vscode understand the formatting in this PR better, right? i.e. they understand each section as a separate cell. That maybe quite handy for people when they download the .py files I think.

lucyleeow · 2020-04-29T12:34:18Z

Yes, the following editors support # %%/#%%:

See: sphinx-gallery/sphinx-gallery#518 (comment)

Edit: updated links as some were out of date

NicolasHug · 2020-04-29T12:36:27Z

@adrinjalali but they don't understand ###########... ?

lucyleeow · 2020-04-29T12:39:55Z

@NicolasHug I don't think so

rth · 2020-04-29T12:42:47Z

IMHO, the current version makes the sections more obvious, especially in text mode

Shouldn't the sections titles be already underlined in rst ?

################################################################
# Section title
# -------------

vs

# %%
# Section title
# -------------

lucyleeow · 2020-04-29T12:48:27Z

Some times ###'s are used to separate parts of code without a new section being defined, e.g.,:

# #############################################################################
# Generate sample data
np.random.seed(0)

from: https://scikit-learn.org/dev/auto_examples/cluster/plot_mini_batch_kmeans.html

NicolasHug · 2020-04-29T13:11:37Z

examples/applications/plot_face_recognition.py

@@ -46,7 +46,7 @@
 logging.basicConfig(level=logging.INFO, format='%(asctime)s %(message)s')


-# #############################################################################
+# %%


@rth , as noted by @thomasjpfan and @lucyleeow these ones should actually be interpreted as plain comments (this is on purpose according to #9061)

I can try to revert if you want

They should be all in the first commit dd7cb01 (as I made a mistake in the regex the first time). If they are plain comments why do we need 80 chars of "#"? For instance in https://scikit-learn.org/dev/auto_examples/cluster/plot_mini_batch_kmeans.html I would just remove them, saying that we # Compute clustering with MiniBatchKMeans doesn't actually need all those #. We don't really comment that way usually, so I'm not sure why put them in examples. Also it's confusing because I really though they were there for sphinx.

But anyway it's a separate discussion happy to revert in this PR.

NicolasHug · 2020-04-29T13:15:46Z

Shouldn't the sections titles be already underlined in rst ?

yes it's fine in genereal since there would be a title just below. But sometimes one would write ######## with no direct title, for example the highlights which render like this

Anyway no strong opinion. If IDEs cannot interpret the current ####### then I guess that's a good reason to switch.

This reverts commit dd7cb01.

NicolasHug · 2020-04-29T13:30:00Z

examples/applications/plot_stock_market.py

@@ -164,6 +164,7 @@
 # Learn a graphical structure from the correlations
 edge_model = covariance.GraphicalLassoCV()

+# %%


looks like there's a bunch of these that should not be added

I added a few manually in 9a63b6e because I though they should have been cells in the first place. Can revert if you prefer.

I would revert and have these adjustments be made separate PRs.

With this PR, we can keep the same formatting as master.

I would revert these and have other PRs insert them.

thomasjpfan

I would prefer not to adjust the formatting on master, since these are cosmetic choices.

thomasjpfan · 2020-04-29T17:48:54Z

examples/covariance/plot_covariance_estimation.py

@@ -66,7 +66,7 @@

 # #############################################################################
 # Compute the likelihood on test data
-
+#


Some of these single # does not change the formatting. In this example, PR and master

This is most likely because the ##### is not connected.

thomasjpfan · 2020-04-29T17:51:47Z

examples/applications/plot_stock_market.py

@@ -164,6 +164,7 @@
 # Learn a graphical structure from the correlations
 edge_model = covariance.GraphicalLassoCV()

+# %%


I would revert and have these adjustments be made separate PRs.

With this PR, we can keep the same formatting as master.

thomasjpfan · 2020-04-29T17:54:21Z

examples/impute/plot_missing_values.py

 # Download the data and make missing values sets
-################################################
+# %%


This can be reverted. The original was correct.

Revert this to make the above a header.

glemaitre · 2020-05-26T09:33:06Z

We would need to resolve the conflict. But the ability to execute the example directly from vs code is a good alternative to starting a jupyter notebook. I think this is worth merging those.

thomasjpfan

A bunch of reverts to leave the rendered formatting alone.

(I am +1 on making this change.)

thomasjpfan · 2020-05-26T22:07:09Z

examples/applications/plot_stock_market.py

@@ -164,6 +164,7 @@
 # Learn a graphical structure from the correlations
 edge_model = covariance.GraphicalLassoCV()

+# %%


I would revert these and have other PRs insert them.

thomasjpfan · 2020-05-26T22:07:41Z

examples/applications/plot_stock_market.py

@@ -223,6 +224,7 @@
 lc.set_linewidths(15 * values)
 ax.add_collection(lc)

+# %%


thomasjpfan · 2020-05-26T22:13:52Z

examples/compose/plot_column_transformer_mixed_types.py

 # Use ``ColumnTransformer`` by selecting column by names
-###############################################################################
+# %%


Revert this.

The second ########################## was used for a header:

This PR:

Master:

examples/compose/plot_column_transformer_mixed_types.py

thomasjpfan · 2020-05-26T22:14:40Z

examples/compose/plot_column_transformer_mixed_types.py

 # Using the prediction pipeline in a grid search
-###############################################################################
+# %%


Revert this to make the above a header.

thomasjpfan · 2020-05-26T22:16:16Z

examples/impute/plot_missing_values.py

 # Download the data and make missing values sets
-################################################
+# %%


Revert this to make the above a header.

thomasjpfan · 2020-05-26T22:16:44Z

examples/miscellaneous/plot_display_object_visualization.py

 # Create :class:`ConfusionMatrixDisplay`
-##############################################################################
+# %%


Revert this to make the above a header.

thomasjpfan · 2020-05-26T22:16:49Z

examples/miscellaneous/plot_display_object_visualization.py

 # Create :class:`RocCurveDisplay`
-##############################################################################
+# %%


Revert this to make the above a header.

thomasjpfan · 2020-05-26T22:16:53Z

examples/miscellaneous/plot_display_object_visualization.py

 # Create :class:`PrecisionRecallDisplay`
-##############################################################################
+# %%


Revert this to make the above a header.

thomasjpfan · 2020-05-26T22:16:57Z

examples/miscellaneous/plot_display_object_visualization.py

 # Combining the display objects into a single plot
-##############################################################################
+# %%


Revert this to make the above a header.

This reverts commit 9a63b6e.

rth · 2020-06-03T20:26:52Z

Should be good now. I have reverted all manual changes, and reverted section titles that were accidentally removed.

thomasjpfan · 2020-06-04T02:14:51Z

The timeout on circleci is concerning. It is also happening on master as well.

thomasjpfan

Thank you @rth!

LGTM

…rn#17068) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>

Doc simpler block delimitation in sphinx examples

dd7cb01

rth mentioned this pull request Apr 28, 2020

Replace "######" separators by "# %%" in gallery #17063

Closed

rth added 2 commits April 28, 2020 11:04

More fixes

be7bed1

Manual fixes

9a63b6e

rth mentioned this pull request Apr 28, 2020

[MRG] EHN support #%% cell separators sphinx-gallery/sphinx-gallery#518

Merged

NicolasHug approved these changes Apr 28, 2020

View reviewed changes

This was referenced Apr 28, 2020

DOC Feature highlights for 0.23 #17062

Merged

DOC Update plot_column_transformer to notebook style #17028

Merged

NicolasHug reviewed Apr 29, 2020

View reviewed changes

rth added 3 commits April 29, 2020 15:21

Revert "Replacing '# ##+'"

c865ada

This reverts commit dd7cb01.

Merge branch 'master' into simpler-example-delimitators

021d6b3

Fix merge conflict

d730bb5

NicolasHug reviewed Apr 29, 2020

View reviewed changes

thomasjpfan reviewed Apr 29, 2020

View reviewed changes

thomasjpfan reviewed May 26, 2020

View reviewed changes

rth added 3 commits June 3, 2020 21:40

Revert "Manual fixes"

4f5368c

This reverts commit 9a63b6e.

Merge branch 'master' into simpler-example-delimitators

83c8cfc

Address review comments

63da98b

A few more fixes

4dbc332

Merge remote-tracking branch 'upstream/master' into pr/17068

e87b06a

thomasjpfan approved these changes Jun 9, 2020

View reviewed changes

thomasjpfan merged commit 94f2e9c into scikit-learn:master Jun 9, 2020

viclafargue pushed a commit to viclafargue/scikit-learn that referenced this pull request Jun 26, 2020

DOC simpler block delimitation in sphinx-gallery examples (scikit-lea…

4ad9c06

…rn#17068) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>

lorentzenchr mentioned this pull request Aug 16, 2020

DOC Add grid search stats example #17432

Merged

jayzed82 pushed a commit to jayzed82/scikit-learn that referenced this pull request Oct 22, 2020

DOC simpler block delimitation in sphinx-gallery examples (scikit-lea…

7a01c9a

…rn#17068) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>

Uh oh!

DOC simpler block delimitation in sphinx-gallery examples #17068

DOC simpler block delimitation in sphinx-gallery examples #17068

Uh oh!

Conversation

rth commented Apr 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adrinjalali commented Apr 28, 2020

Uh oh!

NicolasHug left a comment

Choose a reason for hiding this comment

Uh oh!

rth commented Apr 28, 2020

Uh oh!

thomasjpfan commented Apr 28, 2020

Uh oh!

NicolasHug commented Apr 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adrinjalali commented Apr 29, 2020

Uh oh!

lucyleeow commented Apr 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NicolasHug commented Apr 29, 2020

Uh oh!

lucyleeow commented Apr 29, 2020

Uh oh!

rth commented Apr 29, 2020

Uh oh!

lucyleeow commented Apr 29, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NicolasHug commented Apr 29, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomasjpfan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glemaitre commented May 26, 2020

Uh oh!

thomasjpfan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

rth commented Apr 28, 2020 •

edited

Loading

NicolasHug commented Apr 29, 2020 •

edited

Loading

lucyleeow commented Apr 29, 2020 •

edited

Loading

thomasjpfan left a comment •

edited

Loading