Skip to content

Tidy up reference page #177

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

Merged
merged 1 commit into from
May 13, 2025
Merged

Conversation

alex-ball
Copy link
Contributor

@alex-ball alex-ball commented May 12, 2025

This pull requests fixes two issues with the learners/reference.md page:

  • The page title should not be "FIXME". "Reference" seems reasonable as it contains both a summary of key commands and links to further reading.
  • The Glossary section has no content, so the heading should be removed. To be clear, this is not a comment on the usefulness or otherwise of having a glossary; it only reflects the fact that we do not have a glossary at the moment.

- Follow instruction in "FIXME" page title.
- Remove empty Glossary section. It should be restored if some initial content for it can be agreed.
Copy link

github-actions bot commented May 12, 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/LibraryCarpentry/lc-git/compare/md-outputs..md-outputs-PR-177

The following changes were observed in the rendered markdown documents:

 md5sum.txt   | 2 +-
 reference.md | 6 +-----
 2 files changed, 2 insertions(+), 6 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-05-12 10:00:19 +0000

github-actions bot pushed a commit that referenced this pull request May 12, 2025
@srerickson
Copy link
Contributor

lgtm

@alex-ball alex-ball merged commit 2cb2487 into LibraryCarpentry:main May 13, 2025
3 checks passed
@alex-ball alex-ball deleted the patch-2 branch May 13, 2025 10:56
github-actions bot pushed a commit that referenced this pull request May 13, 2025
Auto-generated via `{sandpaper}`
Source  : 2cb2487
Branch  : main
Author  : Alex Ball <[email protected]>
Time    : 2025-05-13 10:56:00 +0000
Message : Merge pull request #177 from alex-ball/patch-2

Tidy up reference page
github-actions bot pushed a commit that referenced this pull request May 13, 2025
Auto-generated via `{sandpaper}`
Source  : 41c835a
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-05-13 10:56:47 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 2cb2487
Branch  : main
Author  : Alex Ball <[email protected]>
Time    : 2025-05-13 10:56:00 +0000
Message : Merge pull request #177 from alex-ball/patch-2

Tidy up reference page
github-actions bot pushed a commit that referenced this pull request May 20, 2025
Auto-generated via `{sandpaper}`
Source  : 41c835a
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-05-13 10:56:47 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 2cb2487
Branch  : main
Author  : Alex Ball <[email protected]>
Time    : 2025-05-13 10:56:00 +0000
Message : Merge pull request #177 from alex-ball/patch-2

Tidy up reference page
github-actions bot pushed a commit that referenced this pull request May 27, 2025
Auto-generated via `{sandpaper}`
Source  : 41c835a
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-05-13 10:56:47 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 2cb2487
Branch  : main
Author  : Alex Ball <[email protected]>
Time    : 2025-05-13 10:56:00 +0000
Message : Merge pull request #177 from alex-ball/patch-2

Tidy up reference page
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.

2 participants