Documentation Format

Documentation for all operators (methods that involve rx.IObservable) contain the following sections.

Summary

Gives a one line overview, the signature of the method and a description of any arguments that are not self explanatory (like the expect method signatures of any Function arguments).

Unless otherwise specified, operators with a static method signatures are static methods of the rx.Observable class; operators with an instance method signature are method of the rx.IObservable interface.

Remarks

Provides an overview of how the operator works, including situations that will cause it to complete or error.

Marble Diagrams

TODO

Return Value

TODO

Examples

TODO