question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Reorganize examples into different subsections

See original GitHub issue

Sphinx gallery allows us to have subsections in examples. This means we can have a narrative between code, paragraphs, and images.

For example, the plot_permutation_importance example is separated into different subsections.

On the other hand, the plot_kernel_approximation example contains one big paragraph and a huge code block.

I proposal we update our examples to use this subsection structure. Now that we have binder support, it is nicer to have many code cells interlaced with the descriptions.

sprint attendee guideline

  • Check out our example gallery and pick an example you’d like to work on (make sure it’s not already divided into sections!)

  • Please comment below to indicate what example you’re working on

  • Find the corresponding .py file in the examples subdirectory, modifiy it, and submit a PR

  • To build your example locally and see what it looks like, use e.g. EXAMPLES_PATTERN=kernel_approximation make html from the docs folder (more details in the contributing to documentation section)

For inspiration on how to modify your example, look at how plot_permutation_importance.py interleaves text, code, and images. In particular, plt.show() is called multiple times, not just at the end of the file.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:3
  • Comments:27 (24 by maintainers)

github_iconTop GitHub Comments

1reaction
NicolasHugcommented, Aug 24, 2019

@kellycarmody Most of our examples need to be re-organized, not just plot_kernel_approximation

1reaction
anuja-kelkarcommented, Aug 24, 2019

@NicolasHug I will work on plot_kernel_approximation example.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Organize your PowerPoint slides into sections
Try it! Right-click between slides and select Add Section. An Untitled Section is added in the thumbnail pane, and the Rename Section dialog...
Read more >
Reorganizing Drafts - UNC Writing Center
Here are five effective strategies you can use to reorganize: reverse outlining, talking it out, sectioning, listing and narrowing your argument, and ...
Read more >
Parts, chapters, sections, and subsections: how to organize ...
In theory, you can divide subsections further, into sub-subsections starting with C-heads or even smaller sections starting with D-heads. Don't ...
Read more >
Choosing a table reorganization method - IBM
To specify an online reorganization operation, use the INPLACE with FULL, INPLACE with CLEANUP OVERFLOWS, or RECLAIM EXTENTS table clause of the REORG...
Read more >
How to Use Sections in PowerPoint to Organize Slides
Sections created with the Sections command are different from section layouts. In this article ... Below is a sample presentation organized into sections:....
Read more >

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found