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

Consistent styling for bash code blocks #860

Open
5 of 12 tasks
rosemm opened this issue Dec 15, 2023 · 1 comment
Open
5 of 12 tasks

Consistent styling for bash code blocks #860

rosemm opened this issue Dec 15, 2023 · 1 comment
Assignees
Labels
team-reported This issue was generated because of a staff report

Comments

@rosemm
Copy link
Contributor

rosemm commented Dec 15, 2023

Check all modules with command line code blocks (generally, bash or git). Here's a list:

  • bash_command_line_101
  • bash_command_line_102
  • bash_103_combining_commands
  • bash_conditionals_loops
  • bash_scripts
  • docker_101
  • genomics_setup
  • genomics_quality_control
  • git_creation_and_tracking
  • git_history_of_project
  • git_setup_mac_and_linux
  • git_setup_windows

For each, verify the following:

  • Code blocks show either input or output. If a single code block shows both input and output, break it into two. (Note that there's no need to include an output block for every command --- it's fine to have input with no output or vice versa if that makes sense pedagogically.)
  • Input code blocks (commands for learners to run) should be just plan code blocks, starting and ending with a set of backticks and optionally the name of the language but nothing else.
  • Output code blocks (the results displayed in the terminal) should begin with a set of backticks followed by +Output

For example, here's an input block followed by its output block:

```bash
head -n 4 SRR2584863_1.fastq
```

``` +output
@SRR2584863.1 HWI-ST957:244:H73TDADXX:1:1101:4712:2181/1
TTCACATCCTGACCATTCAGTTGAGCAAAATAGTTCTTCAGTGCCTGTTTAACCGAGTCACGCAGGGGTTTTTGGGTTACCTGATCCTGAGAGTTAACGGTAGAAACGGTCAGTACGTCAGAATTTACGCGTTGTTCGAACATAGTTCTG
+
CCCFFFFFGHHHHJIJJJJIJJJIIJJJJIIIJJGFIIIJEDDFEGGJIFHHJIJJDECCGGEGIIJFHFFFACD:BBBDDACCCCAA@@CA@C>C3>@5(8&>C:9?8+89<4(:83825C(:A#########################
```
@rosemm rosemm added the team-reported This issue was generated because of a staff report label Dec 15, 2023
@rosemm
Copy link
Contributor Author

rosemm commented Dec 15, 2023

Note that this change is actually already included in the docs instructions for code blocks! https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/education_modules/main/docs.md#69

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-reported This issue was generated because of a staff report
Projects
None yet
Development

No branches or pull requests

2 participants