Re: [python] Strict type checking on pydoc tool

2017-08-07 Thread Ahmet Altay
Thank you David. I think this is a good proposal and will make docs better for users. We should note that, python developers will need to follow these guidelines. In order to make it easier, I would suggest looking for ways to simplify things (like the one Cham suggested or as you suggested in the

Re: [python] Strict type checking on pydoc tool

2017-08-04 Thread Chamikara Jayalath
Hi David, This is great. Thanks for making our docs better. Looking at your PR, seems like we can either do :class:`~apache_beam.pvalue.PCollection` or ``PCollection`` for highlighting, right ? In Java I think people usually give the link for the first reference in long doc comments and just hig

[python] Strict type checking on pydoc tool

2017-08-04 Thread David Cavazos
Hi, Changes introduced in [BEAM-2655 ] will make the pydoc tool (sphinx) be stricter when checking cross references whenever a cross reference is written. Here are some examples with the type syntax highlighted in bold: """ One line description Th