readme overhaul#1731
Conversation
There was a problem hiding this comment.
The file is removed from here and moved under docs folder but pyproject.toml still points to this deleted file on line number 9
readme = "PYPI.md"
| | `-d, --data TEXT` | Path to directory containing dataset files. Only the last value is used if specified multiple times. | | ||
| | `-dp, --dataset-path TEXT` | Absolute path to a single dataset file. Can be specified multiple times. | | ||
| | `-dxp, --define-xml-path TEXT` | Path to Define-XML. Also via `DEFINE_XML` env var. | | ||
| | `-ft, --filetype TEXT` | File extension filter applied to the `-d` directory (e.g. `xpt`). Takes priority over `--dataset-path` when both are provided. | |
There was a problem hiding this comment.
I think the -ft flag does not override the --dataset-path. They are exclusive.
There was a problem hiding this comment.
-ft, --filetype TEXT File extension to filter datasets. Has higher priority than --dataset-path parameter. This is the current text of the readme. I was just copying it
| | `SUCCESS` | Rule ran; no issues found. | | ||
| | `SKIPPED` | Rule did not run (column/domain not found, schema validation off, outside scope). | | ||
| | `ISSUE_REPORTED` | Rule ran; issues were found. | | ||
| | `EXECUTION_ERROR` | Rule failed unexpectedly. Check the Issue Details tab for details. | |
There was a problem hiding this comment.
These are without _ now. It should be EXECUTION ERROR and ISSUE REPORTED. Please update these for consistency throughout the docs.
RamilCDISC
left a comment
RamilCDISC
left a comment
There was a problem hiding this comment.
The PR updates the readme for the repository to be more organized docs. The updated docs are consistent with the previous read me. The validation was done by reviewing and comparing with previous documentation. In addition all the flags, options links were cross validated against the real code and original pages. All formatting was validated by rendering. The pages and side menu was validated by manual validation.
3 participants
readme overhaul with the intention to host the user guide as a streamlined github pages similar to https://cdisc-org.github.io/cdisc-open-rules/#/