search

microbiome / miaSim

microbiome data simulation package
https://microbiome.github.io/miaSim/
Artistic License 2.0
18 stars 10 forks source link

Unify Documentation(parameters) #84

Closed Daenarys8 closed 1 year ago

Daenarys8 commented 1 year ago

To polish the package, the documentation should be unified (this applies also to packages). This improves the readability and overall quality of the packages.

  1. Parameters. Some parameters are like thisIsParameter, others like this.is.parameter. We agreed to use the latter.

  2. The parameter description should be unified(First the expected class then explain what the parameter does.)