openwhisk-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matt Rutkowski" <mrutk...@us.ibm.com>
Subject Re: Development documents
Date Mon, 12 Jun 2017 16:23:38 GMT
+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" <guoyingc@cn.ibm.com>
To:     dev@openwhisk.apache.org
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 <rodric@gmail.com> wrote: -----
To: dev@openwhisk.apache.org
From: Rodric Rabbah <rodric@gmail.com>
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






Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message