Update section on 'Adding a codelist' #459
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying with
|
| Latest commit: |
d76305f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f783bd13.opensafely-docs.pages.dev |
iaindillingham
requested changes
Oct 12, 2021
docs/codelist-project.md
Outdated
| Take a look at the `codelists/codelists.txt` file in the repo, and note the structure of the existing example codelists that shipped with the research template: | ||
|
|
||
| Your example research template doesn't include any codelists but the folder strucure and text files that are needed to include codelists already exist. | ||
| Take a look at the `codelists/codelist.txt` file in the repo, this file is currently empty but you can add one (or more) strings to this file that specify the codelists that need for your research project. |
There was a problem hiding this comment.
Could you change the path to codelists/codelists.txt here and below? (note the plural) And although it's a nitpick (and so you are free to ignore me!), might it be clearer to replace "strings" with "lines" both here and below? Finally, I think:
... the codelists that need for your research project.
should be:
... the codelists that you need for your research project.
There was a problem hiding this comment.
agree and agree, I also didn't like strings but couldn't really think of anything better, I like lines
docs/codelist-project.md
Outdated
| You need to add each string into a new line of the `codelist.txt` file. | ||
| The next time you run the command `opensafely codelists update` in your terminal, the codelists you specified earlier will be added to the the `codelists/` subfolder in your project automatically so you don't need to add these files manually to your project. | ||
|
|
||
| For example, a `codelist.txt`: file of a project may consist of four different strings: |
There was a problem hiding this comment.
I don't think we need the first colon (:) here.
| ```bash | ||
| opensafely/aplastic-anaemia/2020-04-24 | ||
| opensafely/asplenia/2020-06-02 | ||
| opensafely/current-asthma/2020-05-06 | ||
| primis-covid19-vacc-uptake/bmi_stage/v1.2 |
There was a problem hiding this comment.
Good to give an example of a version number rather than a date 👍🏻
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
<codelist-id>/<tag>Not sure if I added the screenshot correctly and whether there are any naming conventions for the images ...