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.

Sign up for GitHub

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

Jump to bottom

test_readme.py: Validate backticked and single-quoted terms in Markdown #10

Open
2 of 9 tasks
jpmckinney opened this issue Aug 16, 2017 · 2 comments
Open
2 of 9 tasks

test_readme.py: Validate backticked and single-quoted terms in Markdown #10

jpmckinney opened this issue Aug 16, 2017 · 2 comments
Labels
tests

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Aug 16, 2017 •
edited
Loading

We could check that all the following exist in the schema and codelists:

  1. JSON paths, field names, definition names ("building block"), codelist names in backticks:
  • extension readmes
  • documentation websites
  • schema description fields
  1. codes in single quotes
  • extension readmes
  • documentation websites
  • schema description fields
  1. lowerCamelCase and UpperCamelCase words
  • extension readmes
  • documentation websites
  • schema description fields
@jpmckinney jpmckinney changed the title script.sh: Validate JSON Pointers script.sh: Validate JSON Pointers and codes Aug 16, 2017
@jpmckinney jpmckinney changed the title script.sh: Validate JSON Pointers and codes script.sh: Validate JSON Pointers and codes in Markdown Sep 27, 2017
@jpmckinney jpmckinney changed the title script.sh: Validate JSON Pointers and codes in Markdown test_readme.py: Validate JSON Pointers and codes in Markdown Nov 13, 2019
@jpmckinney
Copy link
Member Author

Added test to check that backticked text in extension readmes is either: JSON paths, field names, definition names ("building block"), codelist names, codelist columns, JSON Schema properties, JSON null, JSON booleans, or merge properties.

jpmckinney added a commit that referenced this issue Nov 19, 2019
@jpmckinney
Add tests for validity of backticked and single-quoted text in extens…
39a0111 
…ion readmes, #10
@jpmckinney jpmckinney changed the title test_readme.py: Validate JSON Pointers and codes in Markdown test_readme.py: Validate backticked and single-quoted terms in Markdown Dec 1, 2019
@jpmckinney
Copy link
Member Author

jpmckinney commented Nov 5, 2021 •
edited
Loading

We can consider extending the tests to translations.

We could also go further and ensure that backticked content is identical between the source and translations.

@jpmckinney jpmckinney mentioned this issue Nov 5, 2021
Closed
@jpmckinney jpmckinney mentioned this issue Nov 6, 2023
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
tests
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jpmckinney