mia icon indicating copy to clipboard operation
mia copied to clipboard

Clean up the manpages

Open antagomir opened this issue 1 year ago • 3 comments

The html manpages do not always render well, see e.g. https://microbiome.github.io/mia/reference/getExperimentCrossAssociation.html

antagomir avatar Sep 22 '23 22:09 antagomir

Do we have pending tasks to clean up rendering in manpages?

Daenarys8 avatar Jan 22 '24 09:01 Daenarys8

Could you for instance browse through all reference pages in mia, miaViz, miaTime and see if you notice anything that could be easily improved / clarified?

If examples throw warnings it might be good to either modify the example to get rid of warnings, or comment on why those warnings appear and show how to deal with them.

This task is secondary priority if more urgent tasks pop up.

antagomir avatar Jan 22 '24 09:01 antagomir

Sure will take a look while pending feedback on some commits I pushed earlier.

Daenarys8 avatar Jan 22 '24 09:01 Daenarys8

Status of this one @Daenarys8 ?

antagomir avatar Jul 22 '24 13:07 antagomir

mia and miaViz are addressed in #603 and https://github.com/microbiome/miaViz/pull/140 respectively. Will add a PR for miaTime.

Daenarys8 avatar Jul 22 '24 13:07 Daenarys8

Ok can we close this one or better to keep open still?

antagomir avatar Jul 22 '24 13:07 antagomir

I think we can close.

Daenarys8 avatar Jul 22 '24 14:07 Daenarys8

Great. Please actively close all issues as they become ready.

antagomir avatar Jul 22 '24 14:07 antagomir