Skip to content

Commit 8fd7720

Browse files
committed
Fix PR #98 issues from code review
- Remove internal/ directory with misleading CLAUDE.md files - Remove .serena/ IDE configuration from version control - Add .serena/ and internal/ to .gitignore - Fix GitHub Actions workflow: add mkdocs-material dependency - Fix typos in docs/index.md (resproschema -> reproschema) - Fix incorrect pre-commit command in installation docs - Fix variable name mismatch in redcap2reproschema.md example
1 parent 785195a commit 8fd7720

File tree

8 files changed

+11
-203
lines changed

8 files changed

+11
-203
lines changed

.github/workflows/deploy_mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121

2222
- name: Install dependencies
2323
run: |
24-
pip install mkdocs
24+
pip install mkdocs mkdocs-material
2525
2626
- name: Deploy docs
2727
run: |

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,9 @@ dmypy.json
134134

135135
# Pycharm
136136
.idea/
137+
138+
# Serena IDE configuration
139+
.serena/
140+
141+
# Internal documentation
142+
internal/

.serena/project.yml

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ reproschema requires Python 3.10+
99
index.md # The documentation homepage.
1010
installation.md #A tutorial for installation.
1111
cli_usage.md #Notes on CLI usage
12-
reproschema2redcap.md #How to convert from resproschema to redcap
13-
redcap2reproschema.md #How to convert from redcap to reproscehma
12+
reproschema2redcap.md #How to convert from reproschema to redcap
13+
redcap2reproschema.md #How to convert from redcap to reproschema
1414
output2redcap.md #How to convert the output into redcap
1515
reproschema2fhir.md #How to convert the reproschema into an FHIR Questionnaire Resource

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ pip install -e .
1818
#### Style
1919
This repo uses pre-commit to check styling.
2020
- Install pre-commit with pip: `pip install pre-commit`
21-
- In order to use it with the repository, you have to run `run pre-commit install` in the root directory the first time you use it.
21+
- In order to use it with the repository, you have to run `pre-commit install` in the root directory the first time you use it.
2222

2323
When pre-commit is used, you may have to run git commit twice,
2424
since pre-commit may make additional changes to your code for styling and will

docs/redcap2reproschema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ csv_path = "path-to/your_redcap_data_dic.csv"
4141
yaml_path = "path-to/your_redcap2rs.yaml"
4242
output_path = "path-to/directory_you_want_to_save_output"
4343
44-
redcap2reproschema(csv_file, yaml_file, output_path)
44+
redcap2reproschema(csv_path, yaml_path, output_path)
4545
```

internal/CLAUDE.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

internal/CLAUDE.md.backup

Lines changed: 0 additions & 74 deletions
This file was deleted.

0 commit comments

Comments
 (0)