+1 Javadoc/Scaladoc/xxxDoc There are also expectations in Python (PEP8) that can confirm basic docstrings exist at various places in source modules (which now may be enabled via a PR a couple months ago).
We also have Godoc... but strings can be "empty" to pass basic linting tests. anytime we can auto-generate documentation is valuable IMO. If we, as part of scanning (pre-build) verify (non-empty) linting occurs for various languages (if available) that would be great too. Kind regards, Matt From: "Ying Chun Guo" <[email protected]> To: [email protected] Date: 06/08/2017 10:31 PM Subject: Re: Development documents Hi, Rodric Do you think if using scaladoc to generate dev document is a good idea ? Best regards Ying Chun Guo (Daisy) -----Rodric Rabbah <[email protected]> wrote: ----- To: [email protected] From: Rodric Rabbah <[email protected]> Date: 06/05/2017 02:44PM Subject: Re: Development documents What in particular are you looking for - can you elaborate on the information that you think would be helpful to you? -r
