2.x: cleanup 9/12-1, more Maybe operators, more source code checking

[akarnokd]

• more Maybe operators: onTerminateDetach, repeat, retry
• fixed missing Backpressure: entries of the javadoc where the base type uses Flowable/Publisher
• new base type source parser and check for javadoc mistakes: wrong type mentions, a/an use
• fixes of those javadoc mistakes

[codecov-io]

Current coverage is 78.73% (diff: 61.36%)

Merging #4530 into 2.x will increase coverage by 0.01%

@@                2.x      #4530   diff @@
==========================================
  Files           524        525     +1   
  Lines         34980      35024    +44   
  Methods           0          0          
  Messages          0          0          
  Branches       5443       5447     +4   
==========================================
+ Hits          27535      27576    +41   
- Misses         5466       5474     +8   
+ Partials       1979       1974     -5   

Powered by Codecov. Last update a588c66...74fede6

[akarnokd]

/cc @DavidMGross do you recall any common mistake pattern in the documentation?

[vanniktech]

There could also be a test that checks that every file has a license header.

[akarnokd]

How about adding code that checks the headers and adds them when the unit tests are run locally? I usually just run the JUnit tests from Eclipse.

[akarnokd]

The parser didn't check the instance methods properly so a bunch of mistakes remained. Posting a new PR shortly.

[DavidMGross]

It's been a while since I've worked with the Rx javadocs, but here are some
things worth looking out for:

• parameter names change in the code but the javadocs still refer to the
  old names
• potential exceptions change in the code and the javadocs aren't
  updated to match
• missing backpressure / scheduler / since-annotations, and outdated
  information in each of these
• changing things from consonant- to vowel-sound-starting, doing a
  search-and-replace, and not replacing "a" with "an" or vice-versa to
  match. Also, sometimes changing singulars to plurals or vice-versa by
  search-and-replace, which causes its own set of grammatical headaches.
• if you see any documentation that uses the passive voice, you can
  almost always make it clearer and less prone to misinterpretation by
  rewriting it in the active voice
• URLs for marble diagrams are copy-and-pasted, the name of the operator
  is changed, but the width/height values in the img tag are not, so that the
  right image appears but in the wrong dimensions (there were a couple of
  these in the javadocs last I looked)

I wish I had more time to devote to the Rx docs, but I'm 99% committed to
another project right now.

On Mon, Sep 12, 2016 at 3:49 AM, David Karnok notifications@github.com
wrote:

/cc @DavidMGross https://github.com/DavidMGross do you recall any
common mistake pattern in the documentation?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#4530 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AESHoInXk6N-vtkdgDLbhJJa4E7mv4W7ks5qpS5LgaJpZM4J6buG
.

David M. Gross
PLP Consulting