Skip to content

Conversation

glennj
Copy link
Contributor

@glennj glennj commented Jul 10, 2022

Closes #585

To quote that issue:

The file https://github.com/exercism/bash/blob/main/exercises/shared/.docs/tests.md is used to construct the HELP.md file that is part of the exercism download ... content. It contains a section about what to do with the skip directives.

The file https://github.com/exercism/bash/blob/main/docs/TESTS.md is used for the online docs

The Skipped tests section should appear under Testing Locally.

@glennj glennj added the x:rep/tiny Tiny amount of reputation label Jul 10, 2022
Comment on lines 124 to 125
It can be convenient to use a wrapper function to save on typing:
```bash
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
It can be convenient to use a wrapper function to save on typing:
```bash
It can be convenient to use a wrapper function to save on typing:
```bash

Comment on lines 130 to 134
Then run tests with just:
```bash
bats
```

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Then run tests with just:
```bash
bats
```
Then run tests with just:
```bash
bats

Comment on lines 37 to 38
It can be convenient to use a wrapper function to save on typing:
```bash
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
It can be convenient to use a wrapper function to save on typing:
```bash
It can be convenient to use a wrapper function to save on typing:
```bash

Comment on lines 42 to 44
```
Then run tests with just:
```bash
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
Then run tests with just:
```bash

Then run tests with just:

whitespace around code fences,
markdown style: one line = one sentence; link style
@glennj
Copy link
Contributor Author

glennj commented Jul 10, 2022

@IsaacG I made a couple more changes than your suggestions. Please check the last commit.

@glennj glennj requested a review from IsaacG July 10, 2022 16:40
@glennj glennj merged commit 8bf3a09 into exercism:main Jul 10, 2022
@glennj glennj deleted the align-test-docs branch July 10, 2022 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

x:rep/tiny Tiny amount of reputation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Copy the "Skipped tests" section from tests.md to TESTS.md

2 participants