Skip to content

Add Glossary terms in reference.md#2

Open
jsgro wants to merge 1 commit intomainfrom
jsgro-glossary-1
Open

Add Glossary terms in reference.md#2
jsgro wants to merge 1 commit intomainfrom
jsgro-glossary-1

Conversation

@jsgro
Copy link
Collaborator

@jsgro jsgro commented Oct 23, 2024

Added glossary terms from Copilot.
This might be useful already.

It is also an exercise in requesting a pull-request... Hopefully it's the correct way...

Added glossary terms from Copilot.
@github-actions
Copy link

github-actions bot commented Oct 23, 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/erwinlares/intermediate-software-dev-r/compare/md-outputs..md-outputs-PR-2

The following changes were observed in the rendered markdown documents:

 md5sum.txt   |  2 +-
 reference.md | 22 +++++++++++++++++++++-
 2 files changed, 22 insertions(+), 2 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-10-23 22:45:32 +0000

github-actions bot pushed a commit that referenced this pull request Oct 23, 2024
Copy link
Owner

@erwinlares erwinlares left a comment

Choose a reason for hiding this comment

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

I added some comments, mostly to get used to the process



- **Automation**: The use of technology to perform tasks without human intervention, often to increase efficiency and reduce errors.
- **Binary**: A file format that contains compiled code, which can be executed by a computer.
Copy link
Owner

Choose a reason for hiding this comment

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

we should include that is platform specific

- **Bundle**: A collection of files or resources packaged together, often for distribution or deployment.
- **Continuous Integration (CI)**: A development practice where code changes are automatically tested and integrated into a shared repository frequently.
- **Dataset**: A collection of data, often organized in a structured format, used for analysis or processing.
- **Description**: A detailed explanation or summary of a package, function, or dataset, often found in documentation.
Copy link
Owner

Choose a reason for hiding this comment

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

this definition should be taylored to what the DESCRIPTION file is in the context of package creation

- **Function**: A block of code designed to perform a specific task, which can be reused throughout a program.
- **Function Namespace**: A scope that defines the context in which a function name is unique, preventing naming conflicts.
- **Host / Hosting Platform**: A service or environment where applications, websites, or data are stored and accessible over the internet.
- **In-Memory**: Data that is stored in the RAM of a computer, allowing for fast access and processing.
Copy link
Owner

Choose a reason for hiding this comment

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

in-memory in this context has to do with being available within the current R session

- **Linter**: A tool that analyzes code for potential errors, bugs, stylistic errors, and other issues.
- **Package**: A bundle of software or code that can be easily installed and used in a programming environment.
- **Repository**: A storage location for software packages, code, or data, often used for version control and collaboration.
- **Source**: The original code or data from which software is built or compiled.
Copy link
Owner

Choose a reason for hiding this comment

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

It is somewhat human-readable

## Glossary

This is a placeholder file. Please add content here.
JYS: Here is a first draft of glossary made by Copilot, to be verified/edited as needed
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd remove this line since it shouldn't be in the rendered file.

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.

3 participants