Drasil icon indicating copy to clipboard operation
Drasil copied to clipboard

Published 20 hours ago • verified publisher icon JacquesCarette

Add missing documentation for functions

Open janim2-2004 opened this issue 1 year ago • 3 comments

As mentioned in #3505 image The following warnings are given when running make doc, to get rid of these warnings we should add documentation for the respective concepts.

janim2-2004 avatar Jun 29 '23 13:06 janim2-2004

I have a question about this issue.

After taking a look at all three files "Control.py", "OutputFormat.py", and "InputParameters.py", I did not find the corresponding code that prints out the documentation message. Where is the code section doing this?

daijingz avatar Jul 13 '23 19:07 daijingz

To help users to get rid of this warning category, can I just add an extra section in the README file from this location: https://github.com/JacquesCarette/Drasil/tree/master/code/stable/projectile/projectile_c_p_nol_b_u_v_d/src/python

Seems like this file is the most appropriate place

daijingz avatar Jul 13 '23 20:07 daijingz

That is generated code (even the README), so this should be changed in the generator.

JacquesCarette avatar Jul 13 '23 20:07 JacquesCarette