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

Improve formatting of episode 16 solution #681

Merged
merged 1 commit into from
Jun 13, 2024

Conversation

danny-lloyd
Copy link
Contributor

@danny-lloyd danny-lloyd commented Jun 11, 2024

Simulating a dynamical system solution had a new line in the code block which caused the whole block not to be rendered.

URL: https://swcarpentry.github.io/python-novice-gapminder/16-writing-functions.html

Before and after screenshots below:

Screenshot 2024-06-11 at 09 54 13

After:

Screenshot 2024-06-11 at 09 54 26

Simulating a dynamical system solution had a new line in the code block which caused the whole block not to be rendered.
Copy link

github-actions bot commented Jun 11, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/python-novice-gapminder/compare/md-outputs..md-outputs-PR-681

The following changes were observed in the rendered markdown documents:

 16-writing-functions.md | 12 ++++++++----
 md5sum.txt              |  2 +-
 2 files changed, 9 insertions(+), 5 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-06-12 06:05:14 +0000

@vahtras
Copy link
Contributor

vahtras commented Jun 11, 2024

Good catch. However there is some strange side effect on the last solution cell. Please check

Screenshot 2024-06-11 at 21 52 06

github-actions bot pushed a commit that referenced this pull request Jun 12, 2024
@alee
Copy link
Member

alee commented Jun 12, 2024

Thanks! I checked the branch out locally and rendered it using the latest sandpaper and it looked good to me, maybe there was an older version of sandpaper @vahtras ?

example docker-compose.yml file to be placed in the root directory and can render the site via docker compose up -d:

services:
  server:
    image: ghcr.io/uomresearchit/sandpaper:latest  # switch to `latest_arm` for macos
    volumes:
      - ./:/siteroot
    ports:
      - "127.0.0.1:4321:4321"

@danny-lloyd
Copy link
Contributor Author

I tested this locally on macOS by following the instructions here. For reference, I ran brew install r, installed the required packages, and then rendered it with sandpaper::serve().

I also tested this with @alee's dockerfile and can't see that style error:

Screenshot 2024-06-12 at 09 13 17

@vahtras
Copy link
Contributor

vahtras commented Jun 13, 2024

I did an upgrade of sandpaper and the the problem disappeared. Who knows what is was.

@vahtras vahtras merged commit 4837564 into swcarpentry:main Jun 13, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 13, 2024
Auto-generated via {sandpaper}
Source  : 4837564
Branch  : main
Author  : Olav Vahtras <[email protected]>
Time    : 2024-06-13 05:31:50 +0000
Message : Merge pull request #681 from danny-lloyd/improve-formatting-ep16

Improve formatting of episode 16 solution
github-actions bot pushed a commit that referenced this pull request Jun 13, 2024
Auto-generated via {sandpaper}
Source  : 031c8c0
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-13 05:32:40 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4837564
Branch  : main
Author  : Olav Vahtras <[email protected]>
Time    : 2024-06-13 05:31:50 +0000
Message : Merge pull request #681 from danny-lloyd/improve-formatting-ep16

Improve formatting of episode 16 solution
github-actions bot pushed a commit that referenced this pull request Jun 18, 2024
Auto-generated via {sandpaper}
Source  : 031c8c0
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-13 05:32:40 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4837564
Branch  : main
Author  : Olav Vahtras <[email protected]>
Time    : 2024-06-13 05:31:50 +0000
Message : Merge pull request #681 from danny-lloyd/improve-formatting-ep16

Improve formatting of episode 16 solution
github-actions bot pushed a commit that referenced this pull request Jun 25, 2024
Auto-generated via {sandpaper}
Source  : 031c8c0
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-13 05:32:40 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4837564
Branch  : main
Author  : Olav Vahtras <[email protected]>
Time    : 2024-06-13 05:31:50 +0000
Message : Merge pull request #681 from danny-lloyd/improve-formatting-ep16

Improve formatting of episode 16 solution
github-actions bot pushed a commit that referenced this pull request Jun 25, 2024
Auto-generated via {sandpaper}
Source  : 031c8c0
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-13 05:32:40 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4837564
Branch  : main
Author  : Olav Vahtras <[email protected]>
Time    : 2024-06-13 05:31:50 +0000
Message : Merge pull request #681 from danny-lloyd/improve-formatting-ep16

Improve formatting of episode 16 solution
github-actions bot pushed a commit that referenced this pull request Jul 2, 2024
Auto-generated via {sandpaper}
Source  : 031c8c0
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-13 05:32:40 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4837564
Branch  : main
Author  : Olav Vahtras <[email protected]>
Time    : 2024-06-13 05:31:50 +0000
Message : Merge pull request #681 from danny-lloyd/improve-formatting-ep16

Improve formatting of episode 16 solution
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

3 participants