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

Replace excel screenshots by embedded file contents #598

Merged
merged 2 commits into from
Dec 14, 2023

Conversation

Bisaloo
Copy link
Member

@Bisaloo Bisaloo commented Nov 11, 2023

Fix #434.

This will also be hopefully more accessible for visitors using screenreaders since they can now more easily access the full information that was previously summarized in a terse alt text.

Copy link

github-actions bot commented Nov 11, 2023

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/r-novice-inflammation/compare/md-outputs..md-outputs-PR-598

The following changes were observed in the rendered markdown documents:

 11-supp-read-write-csv.md   | 43 ++++++++++++++++-----
 data/car-speeds-cleaned.csv | 94 ---------------------------------------------
 md5sum.txt                  |  2 +-
 3 files changed, 35 insertions(+), 104 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 2023-12-02 12:34:39 +0000

github-actions bot pushed a commit that referenced this pull request Nov 11, 2023
Copy link
Member

@HaoZeke HaoZeke left a comment

Choose a reason for hiding this comment

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

Thanks for this @Bisaloo. Would it be possible to embed only a few lines? Currently this adds way too much to the length of the document which would likely be problematic from an accessibility standpoint.

Copy link
Member

@HaoZeke HaoZeke left a comment

Choose a reason for hiding this comment

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

See previous comment :)

@Bisaloo
Copy link
Member Author

Bisaloo commented Dec 2, 2023

I'm still unsure of what would be the best way to do this.

I went with saving only head() of the data. Alternatively, we could truncate the files before reading them with echo = FALSE to not distract the readers from the main point but I'm always wary of doing operations behind the scenes.

github-actions bot pushed a commit that referenced this pull request Dec 2, 2023
@Bisaloo Bisaloo requested a review from HaoZeke December 13, 2023 12:38
Copy link
Member

@HaoZeke HaoZeke left a comment

Choose a reason for hiding this comment

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

LGTM now, thanks @Bisaloo.

@HaoZeke HaoZeke merged commit b1dcb95 into main Dec 14, 2023
3 checks passed
@HaoZeke HaoZeke deleted the issue-434-excel-screenshots branch December 14, 2023 22:24
github-actions bot pushed a commit that referenced this pull request Dec 14, 2023
Auto-generated via {sandpaper}
Source  : b1dcb95
Branch  : main
Author  : Rohit Goswami <[email protected]>
Time    : 2023-12-14 22:24:13 +0000
Message : Merge pull request #598 from swcarpentry/issue-434-excel-screenshots

Replace excel screenshots by embedded file contents
github-actions bot pushed a commit that referenced this pull request Dec 14, 2023
Auto-generated via {sandpaper}
Source  : 6380440
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-12-14 22:25:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : b1dcb95
Branch  : main
Author  : Rohit Goswami <[email protected]>
Time    : 2023-12-14 22:24:13 +0000
Message : Merge pull request #598 from swcarpentry/issue-434-excel-screenshots

Replace excel screenshots by embedded file contents
github-actions bot pushed a commit that referenced this pull request Dec 19, 2023
Auto-generated via {sandpaper}
Source  : b1dcb95
Branch  : main
Author  : Rohit Goswami <[email protected]>
Time    : 2023-12-14 22:24:13 +0000
Message : Merge pull request #598 from swcarpentry/issue-434-excel-screenshots

Replace excel screenshots by embedded file contents
github-actions bot pushed a commit that referenced this pull request Dec 19, 2023
Auto-generated via {sandpaper}
Source  : a6ea81d
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-12-19 00:23:43 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : b1dcb95
Branch  : main
Author  : Rohit Goswami <[email protected]>
Time    : 2023-12-14 22:24:13 +0000
Message : Merge pull request #598 from swcarpentry/issue-434-excel-screenshots

Replace excel screenshots by embedded file contents
github-actions bot pushed a commit that referenced this pull request Dec 26, 2023
Auto-generated via {sandpaper}
Source  : a6ea81d
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-12-19 00:23:43 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : b1dcb95
Branch  : main
Author  : Rohit Goswami <[email protected]>
Time    : 2023-12-14 22:24:13 +0000
Message : Merge pull request #598 from swcarpentry/issue-434-excel-screenshots

Replace excel screenshots by embedded file contents
github-actions bot pushed a commit that referenced this pull request Jan 2, 2024
Auto-generated via {sandpaper}
Source  : a6ea81d
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-12-19 00:23:43 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : b1dcb95
Branch  : main
Author  : Rohit Goswami <[email protected]>
Time    : 2023-12-14 22:24:13 +0000
Message : Merge pull request #598 from swcarpentry/issue-434-excel-screenshots

Replace excel screenshots by embedded file contents
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.

CSV file photos are screen shots of Excel files instead of CSV files
2 participants