search

AlphaGenes / AlphaPeel

AlphaPeel: calling, phasing, and imputing genotype and sequence data in pedigrees
MIT License
2 stars 11 forks source link

Remove double brackets in documentation #120

Open XingerTang opened 8 months ago

XingerTang commented 8 months ago

@gregorgorjanc

Even with the description, the double brackets in documentation (e.g. pedigree [PEDIGREE [PEDIGREE ...]]) are still confusing. I suggest we just remove the original double brackets and use multiple brackets instead.

Since if we want to input multiple entries the format we actually use is by putting an empty space between the entries, maybe pedigree [PEDIGREE] [PEDIGREE] ... is a better way to represent the multiple entries.

Or we can simply use the default help message output for the multiple entries, that we kept only one bracket with some ellipses, (e.g. pedigree [PEDIGREE ...]).

gregorgorjanc commented 8 months ago

@XingerTang I like this proposal: pedigree [PEDIGREE ...]