Improve documentation - Githubissues

populationgenomics / cpg-infrastructure

This repository is used to manage the infrastructure at the CPG

MIT License

3 stars 1 forks source link

Improve documentation #190

Closed illusional closed 10 months ago

illusional commented 10 months ago

And:

moved some configuration options around because it makes more sense,
allow the specification of Literals in the config (that check the value)

@jmarshall, I think you're fairly fresh to this repo, so a good target to see how the explanation lands. Not saying this is complete, it can be improved, but keen to get progressive improvements out.

codecov-commenter commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:exclamation: No coverage uploaded for pull request base (main@7e5b550). Click here to learn what that means.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #190 +/- ## ======================================= Coverage ? 90.47% ======================================= Files ? 4 Lines ? 399 Branches ? 0 ======================================= Hits ? 361 Misses ? 38 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

illusional commented 10 months ago

@jmarshall, I'm expecting the preview to fail because I've moved a config option. I've added another PR to fix it

jmarshall commented 10 months ago

I'm expecting the preview to fail because I've moved a config option. I've added another PR to fix it

Hmmm… preview seems to have failed because cpg-infra/README.md is gone but setup.py wants to read the long description from it. Is this what you were expecting? Not sure I spotted the other PR, and it sounds like it was addressing something else…