Skip to content

Conversation

@anenadic
Copy link
Collaborator

@anenadic anenadic commented Nov 27, 2025

Fix read_json_to_dataframe function's docstring - the function does not sort data any more (just cleans) as that bit of code is moved to main.

Fixes #350.

@github-actions
Copy link

github-actions bot commented Nov 27, 2025

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/carpentries-incubator/better-research-software/compare/md-outputs..md-outputs-PR-351

The following changes were observed in the rendered markdown documents:

 04-code-readability.md   | 4 ++--
 06-code-correctness.md   | 2 +-
 08-open-collaboration.md | 2 +-
 md5sum.txt               | 7 +++----
 4 files changed, 7 insertions(+), 8 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 2025-11-27 09:26:12 +0000

github-actions bot pushed a commit that referenced this pull request Nov 27, 2025
Copy link
Contributor

@sstevens2 sstevens2 left a comment

Choose a reason for hiding this comment

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

Thanks Aleks!

@sstevens2 sstevens2 merged commit fa9642a into main Dec 3, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 3, 2025
Auto-generated via `{sandpaper}`
Source  : fa9642a
Branch  : main
Author  : Sarah Stevens <[email protected]>
Time    : 2025-12-03 15:43:28 +0000
Message : Merge pull request #351 from carpentries-incubator/issue-350-fix-docstring

Fix docstring - function is not sorting data
github-actions bot pushed a commit that referenced this pull request Dec 3, 2025
Auto-generated via `{sandpaper}`
Source  : 5a3ed9b
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-12-03 15:44:39 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : fa9642a
Branch  : main
Author  : Sarah Stevens <[email protected]>
Time    : 2025-12-03 15:43:28 +0000
Message : Merge pull request #351 from carpentries-incubator/issue-350-fix-docstring

Fix docstring - function is not sorting data
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.

Fix read_json_to_dataframe function's docstring summary

3 participants