Skip to content
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

docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site #446

Conversation

Marsmaennchen221
Copy link
Contributor

@Marsmaennchen221 Marsmaennchen221 commented Jul 11, 2023

Closes #447.

Summary of Changes

docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site
docs: Removed a warning in the data processing tutorial
docs: Added table of contents to data processing tutorial
docs: Shorten output in "Data Processing" tutorial to speed up loading the page

Used the html note like we discussed in #419

docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site
docs: Added table of contents to data processing tutorial
@Marsmaennchen221 Marsmaennchen221 requested a review from a team as a code owner July 11, 2023 23:10
@codecov
Copy link

codecov bot commented Jul 11, 2023

Codecov Report

Merging #446 (ad314b3) into main (6e9ff69) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #446   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           49        49           
  Lines         2667      2667           
=========================================
  Hits          2667      2667           

@github-actions
Copy link
Contributor

github-actions bot commented Jul 11, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ CSS stylelint 1 0 0 1.04s
✅ JSON prettier 1 0 0 0.54s
✅ REPOSITORY git_diff yes no 0.06s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@lars-reimann
Copy link
Member

lars-reimann commented Jul 12, 2023

  • Good idea and I'd definitely keep the max height. However, we also need to keep in mind that the data will still bloat the generated HTML, so truncating the output is still required to keep its size down.

  • For some reason the data processing tutorial loads extremely slowly now. It's fine on stable but already slow on latest, so probably unrelated to your changes. It's likely the sheer size of the page (see previous point). -> Data processing tutorial loads very slowly #447.

  • There's also still one warning:

image

@zzril
Copy link
Contributor

zzril commented Jul 12, 2023

docs: Added table of contents to data processing tutorial

There should be more chapters. At the very least, a "General" section for everything before the Transform Table/Colunm sections.
Possible use a separate section for loading the data as well.

Also, now with #419 merged, that one should probably also get such a table of content now.

@lars-reimann
Copy link
Member

lars-reimann commented Jul 12, 2023

I've added a fix for #447 here too since you were working on that notebook anyway.

Copy link
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's now another warning:

image

I don't find that helpful though since the example code is perfectly valid and will remove it in another PR.

@lars-reimann lars-reimann merged commit e92c862 into main Jul 12, 2023
@lars-reimann lars-reimann deleted the fix-warning-in-data-processing-tutorial-and-set-max-height-for-output-cells branch July 12, 2023 19:29
@lars-reimann
Copy link
Member

🎉 This PR is included in version 0.15.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Included in a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Data processing tutorial loads very slowly
4 participants