glotaran / pyglotaran

A Python library for Global and Target Analysis of time-resolved spectroscopy data
GNU Lesser General Public License v3.0
53 stars 18 forks source link

🧹 Remove doc render workaround in result markdown repr #1485

Closed s-weigand closed 2 months ago

s-weigand commented 2 months ago

This PR removes the hacky workaround added in #1244 for the details section the Result markdown repr not to break the render.

Looking in the pandoc release notes I found this note.

Add summary to list of block-level HTML tags (#6385). This improves support for summary/details inside Markdown. NOTE: you need to include a blank line before the closing , if you want the last part of the content to be parsed as a paragraph.

So I gave it a shot and it worked locally. I'm a bit confused about our initial problem since the repr before #1244 also included a newline before closing the tab 🤷‍♀️

Change summary

Checklist

sourcery-ai[bot] commented 2 months ago

🧙 Sourcery has finished reviewing your pull request!


Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
github-actions[bot] commented 2 months ago

Binder :point_left: Launch a binder notebook on branch s-weigand/pyglotaran/remove-details-workaround

github-actions[bot] commented 2 months ago

Benchmark is done. Checkout the benchmark result page. Benchmark differences below 5% might be due to CI noise.

Benchmark diff v0.7.2 vs. main ``` All benchmarks: | Change | Before [1fb14bbc] | After [941c4923] | Ratio | Benchmark (Parameter) | |----------|------------------------------|---------------------|---------|-----------------------------------------| | | 237M | 237M | 1.00 | IntegrationTwoDatasets.peakmem_optimize | | | 1.65±0.07s | 1.37±0.03s | ~0.83 | IntegrationTwoDatasets.time_optimize | ```
Benchmark diff main vs. PR ``` All benchmarks: | Change | Before [941c4923] | After [e6953e5d] | Ratio | Benchmark (Parameter) | |----------|----------------------|---------------------|---------|-----------------------------------------| | | 237M | 237M | 1 | IntegrationTwoDatasets.peakmem_optimize | | | 1.37±0.03s | 1.45±0.09s | 1.06 | IntegrationTwoDatasets.time_optimize | ```
codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.6%. Comparing base (2c88dce) to head (e6953e5). Report is 7 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1485 +/- ## ===================================== Coverage 88.6% 88.6% ===================================== Files 107 107 Lines 5128 5133 +5 Branches 962 965 +3 ===================================== + Hits 4544 4549 +5 Misses 468 468 Partials 116 116 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

s-weigand commented 2 months ago

NVM it seems I just hit the local cache, and this is still an issue. 🤦‍♀️