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

Html repr with JupyterLab TOC #902

Merged
merged 9 commits into from Jul 7, 2023
Merged

Html repr with JupyterLab TOC #902

merged 9 commits into from Jul 7, 2023

Conversation

newville
Copy link
Member

@newville newville commented Jul 7, 2023

]

Description

This should replace #883, and follows from discussion #884

Type of Changes
  • Bug fix
  • New feature
  • Refactoring / maintenance
  • Documentation / examples
Tested on
Verification

Have you

  • included docstrings that follow PEP 257?
  • referenced existing Issue and/or provided relevant link to mailing list?
  • verified that existing tests pass locally?
  • verified that the documentation builds locally?
  • squashed/minimized your commits and written descriptive commit messages?
  • added or updated existing tests to cover the changes?
  • updated the documentation and/or added an entry to the release notes (doc/whatsnew.rst)?
  • added an example?

@codecov
Copy link

codecov bot commented Jul 7, 2023

Codecov Report

Merging #902 (37e22ce) into master (4968ef2) will decrease coverage by 0.01%.
The diff coverage is 93.33%.

@@            Coverage Diff             @@
##           master     #902      +/-   ##
==========================================
- Coverage   93.23%   93.23%   -0.01%     
==========================================
  Files          10       10              
  Lines        3683     3693      +10     
==========================================
+ Hits         3434     3443       +9     
- Misses        249      250       +1     
Impacted Files Coverage Δ
lmfit/minimizer.py 89.83% <0.00%> (-0.10%) ⬇️
lmfit/model.py 91.25% <100.00%> (ø)
lmfit/printfuncs.py 97.92% <100.00%> (+0.06%) ⬆️

@newville newville mentioned this pull request Jul 7, 2023
12 tasks
@eendebakpt
Copy link
Contributor

eendebakpt commented Jul 7, 2023

For reference: the old representation (in JupyterLab):

image

and the one with this PR:

image

@eendebakpt
Copy link
Contributor

The PR addresses the issue from #883 (e.g. the lmfit output adding many sections to the table of contents). The formatting style is off course subjective, but it looks good to me.

The only thing that bothers me a bit is the final caption (for Correlations) that is split between two lines for no apparent reason.

@newville
Copy link
Member Author

newville commented Jul 7, 2023

@eendebakpt I updated the HTML generation to have column headers for the correlation table, which should help, and to left-align most of the text.

If you find this acceptable, I'll merge this in.

@reneeotten
Copy link
Contributor

@newville looks good to me! Can you please do a "squash-and-merge" and update the commit message so we're not left with all the mess (after all this should just be one commit anyway) 😉

@newville
Copy link
Member Author

newville commented Jul 7, 2023

@reneeotten yep, I will squash and merge.

@newville newville merged commit 4d5df88 into master Jul 7, 2023
15 checks passed
@newville newville deleted the html_repr_jp_toc branch February 22, 2024 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants