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.

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

Indented bullet points are not rendering correctly #1

Open
dvg-p4 opened this issue Sep 15, 2022 · 0 comments
Open

Indented bullet points are not rendering correctly #1

dvg-p4 opened this issue Sep 15, 2022 · 0 comments

Comments

@dvg-p4
Copy link

dvg-p4 commented Sep 15, 2022

In a number of places in the documentation, you seem to be trying to make multi-level bulleted lists. e.g. in https://raw.githubusercontent.com/saigegit/SAIGE-doc/saige-pages/docs/set_step1.md:

1.  When a sparse GRM is used to fit the null model (--useSparseGRMtoFitNULL=TRUE)

   * Multiple variance ratios need to be estimated based on different minor allele count categories with *--isCateVarianceRatio=TRUE*
       ** Different from Step 1 in SAIGE for single-variant tests in SAIGE, in which only a single variance ratio is estiamted
       ** By default, two variance ratios are estiamted for 10 <= MAC < 20 and MAC >= 20.

However, the two-star inner bullet points are not a valid syntax for a markdown file, which results in these sections failing to render properly in the html:
https://saigegit.github.io/SAIGE-doc/docs/set_step1.html
image
I suspect removing the second asterisk from each of these lines would solve the problem.

Relatedly, *--isCateVarianceRatio=TRUE* condenses the double-dash into an emdash--it would be better to put this into an inline code block, like such:
[...]`--isCateVarianceRatio=TRUE`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant