Skip to content

Commit

Permalink
Deploy latest changes (#425)
Browse files Browse the repository at this point in the history
  • Loading branch information
akarnokd authored Jun 5, 2024
1 parent ac29896 commit 3628760
Show file tree
Hide file tree
Showing 21 changed files with 507 additions and 80 deletions.
39 changes: 0 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,45 +10,6 @@ Use Docker to Build & Run (Optional)
If you have Docker installed, you can use the Dockerfile in this repository to build and run the ReactiveX website. This one-liner will perform the build and run:
`docker build -t reactivex.io - < Dockerfile && docker run -p 4000:4000 -it --rm -v $PWD:/app -t reactivex.io`

### Windows

Requires docker desktop.

```
docker build -t reactivex.io - < Dockerfile
docker run -p 4000:4000 -e JEKYLL_ENV=production -it --rm -v $PWD:/app -t reactivex.io
```

*Note the `-e JEKYLL_ENV=production`. It is required otherwise jekyll will riddle the page links with `https:/0.0.0.0`.*

Replace `$PWD` with the absolute path of the git repo, i.e., `c:\users\akarnokd\git\reactivex.github.io`

When run finishes, the updated site should be in `_site`. The contents of this directory has to go into the `master` branch.

```
cd c:\temp
git clone https://github.com/ReactiveX/reactivex.github.io.git
cd reactivex.github.io
git checkout master
git checkout -b master_next
rem Copy contents of _site into the current dir at this point
git add .
git commit -m "Deploying changes"
git push --set-upstream origin master_next
rem Review the PR
```


Install tools
--------------

Expand Down
2 changes: 1 addition & 1 deletion css/bootstrap.min.css

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions documentation/observable.html
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,21 @@ <h2>Chaining Operators</h2>
chain, but they operate <em>in turn</em>, each one operating on the Observable generated by the operator
immediately previous in the chain.
</p>
<h2>Null values</h2>
<p>
In certain ReactiveX implementations, such as <em>RxJava 2.x</em> and <em>RxJava 3.x</em>, <code>null</code> values are no longer allowed
due to the now mandatory compatibility with the <a href="https://github.com/reactive-streams/reactive-streams-jvm#2.13" target="_blank">Reactive Streams specification</a>.
</p>
<p>
In general, <code>null</code>s can be ambiguous in a sense that there is no good way to distinguish between a not-present indication and a bug that returns it instead of throwing an exception. If one really needs such a not-present indicator, consider using the <code>Optional&lt;T&gt;</code> (in Java 8+) or similar construct to wrap a potentially nullable <code>T</code> and let it travel on the chain.
</p>
<p>
Yes, using this approach introduces memory overhead and indirection (and some inconvenience). However, if one thinks about this, supporting <code>null</code> this way
would introduce the overhead everywhere (as it has for <em>RxJava 1.x</em>), even though mostly unnecessarily for a vast majority of use cases.
</p>
<p>
Therefore, <em>RxJava 2.x</em> and <em>RxJava 3.x</em> eagerly check for argument nullness, return value nullness from user-provided callbacks and will almost never invoke an user-provided callback with <code>null</code>, unless stated otherwise in the particular operator's documentation.
</p>

</div>
<div class="col-sm-4">
Expand Down
1 change: 1 addition & 0 deletions documentation/operators.html
Original file line number Diff line number Diff line change
Expand Up @@ -1005,6 +1005,7 @@ <h1 id="alphabetical" style="clear: left;">An Alphabetical List of Observable Op
<li><a href="/documentation/operators/debounce.html"><code>Throttle</code></a></li>
<li><a href="/documentation/operators/sample.html"><code>throttleFirst</code></a></li>
<li><a href="/documentation/operators/sample.html"><code>throttleLast</code></a></li>
<li><a href="/documentation/operators/throttlelatest.html"><code>throttleLatest</code></a></li>
<li><a href="/documentation/operators/debounce.html"><code>throttleWithSelector</code></a></li>
<li><a href="/documentation/operators/debounce.html"><code>throttleWithTimeout</code></a></li>
<li><a href="/documentation/operators/empty-never-throw.html"><strong><code>Throw</code></strong></a></li>
Expand Down
39 changes: 8 additions & 31 deletions documentation/operators/flatmap.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ <h4 class="panel-title">
<div class="panel-heading" role="tab" id="headingRxGroovy">
<h4 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion" href="#collapseRxGroovy" aria-expanded="true" aria-controls="collapseRxGroovy">
RxGroovy <code>concatMap flatMap flatMapIterable StringObservable.split switchMap</code>
RxGroovy <code>concatMap flatMap flatMapIterable switchMap</code>
</a>
</h4>
</div>
Expand Down Expand Up @@ -256,7 +256,7 @@ <h4>Sample Code</h4>
by <code>flatMap</code> aborts by invoking <code>onError</code>, the Observable produced by
<code>flatMap</code> will itself immediately abort and invoke <code>onError</code>.
</p><p>
A version of this variant of the operator (still in Beta as of this writing) takes an additional
A version of this variant of the operator takes an additional
<code>int</code> parameter. This parameter sets the maximum number of concurrent subscriptions
that <code>flatMap</code> will attempt to have to the Observables that the items emitted by the source
Observable map to. When it reaches this maximum number, it will wait for one of those Observables to
Expand All @@ -273,7 +273,7 @@ <h4>Sample Code</h4>
Another version of <code>flatMap</code> creates (and flattens) a new Observable for each item
<em>and notification</em> from the source Observable.
</p><p>
A version of this variant of the operator (still in Beta as of this writing) takes an additional
A version of this variant of the operator takes an additional
<code>int</code> parameter. This parameter sets the maximum number of concurrent subscriptions
that <code>flatMap</code> will attempt to have to the Observables that the items emitted by the source
Observable map to. When it reaches this maximum number, it will wait for one of those Observables to
Expand All @@ -290,7 +290,7 @@ <h4>Sample Code</h4>
Another version combines items from the source Observable with the Observable triggered by
those source items, and emits these combinations.
</p><p>
A version of this variant of the operator (still in Beta as of this writing) takes an additional
A version of this variant of the operator takes an additional
<code>int</code> parameter. This parameter sets the maximum number of concurrent subscriptions
that <code>flatMap</code> will attempt to have to the Observables that the items emitted by the source
Observable map to. When it reaches this maximum number, it will wait for one of those Observables to
Expand Down Expand Up @@ -336,20 +336,6 @@ <h4>Sample Code</h4>
<li>Javadoc: <a href="http://reactivex.io/RxJava/javadoc/rx/Observable.html#switchMap(rx.functions.Func1)"><code>switchMap(Func1)</code></a></li>
</ul></figcaption>
</figure>
<figure class="variant">
<img src="images/St.split.png" style="width:100%;" alt="split" />
<figcaption><p>
In the distinct <code>StringObservable</code> class (not part of RxGroovy by default) there is also a
<code>split</code> operator that converts an Observable of Strings into an Observable of Strings that
treats the source sequence as a stream and splits it on a specified regex boundary, then merges the
results of this split.
</p>
<h4>See Also</h4>
<ul>
<li><a href="http://www.nurkiewicz.com/2014/12/accessing-meetups-streaming-api-with.html">Aligning packets with JSON documents</a> with the <code>split</code> operator</li>
</ul>
</figcaption>
</figure>

</div>
</div>
Expand All @@ -361,7 +347,7 @@ <h4>See Also</h4>
<div class="panel-heading" role="tab" id="headingRxJava&nbsp;1․x">
<h4 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion" href="#collapseRxJava&nbsp;1․x" aria-expanded="true" aria-controls="collapseRxJava&nbsp;1․x">
RxJava&nbsp;1․x <code>concatMap flatMap flatMapIterable StringObervable.split switchMap</code>
RxJava&nbsp;1․x <code>concatMap flatMap flatMapIterable switchMap</code>
</a>
</h4>
</div>
Expand All @@ -377,7 +363,7 @@ <h4 class="panel-title">
by <code>flatMap</code> aborts by invoking <code>onError</code>, the Observable produced by
<code>flatMap</code> will itself immediately abort and invoke <code>onError</code>.
</p><p>
A version of this variant of the operator (still in Beta as of this writing) takes an additional
A version of this variant of the operator takes an additional
<code>int</code> parameter. This parameter sets the maximum number of concurrent subscriptions
that <code>flatMap</code> will attempt to have to the Observables that the items emitted by the source
Observable map to. When it reaches this maximum number, it will wait for one of those Observables to
Expand All @@ -394,7 +380,7 @@ <h4 class="panel-title">
Another version of <code>flatMap</code> creates (and flattens) a new Observable for each item
<em>and notification</em> from the source Observable.
</p><p>
A version of this variant of the operator (still in Beta as of this writing) takes an additional
A version of this variant of the operator takes an additional
<code>int</code> parameter. This parameter sets the maximum number of concurrent subscriptions
that <code>flatMap</code> will attempt to have to the Observables that the items emitted by the source
Observable map to. When it reaches this maximum number, it will wait for one of those Observables to
Expand All @@ -411,7 +397,7 @@ <h4 class="panel-title">
Another version combines items from the source Observable with the Observable triggered by
those source items, and emits these combinations.
</p><p>
A version of this variant of the operator (still in Beta as of this writing) takes an additional
A version of this variant of the operator takes an additional
<code>int</code> parameter. This parameter sets the maximum number of concurrent subscriptions
that <code>flatMap</code> will attempt to have to the Observables that the items emitted by the source
Observable map to. When it reaches this maximum number, it will wait for one of those Observables to
Expand Down Expand Up @@ -457,15 +443,6 @@ <h4 class="panel-title">
<li>Javadoc: <a href="http://reactivex.io/RxJava/javadoc/rx/Observable.html#switchMap(rx.functions.Func1)"><code>switchMap(Func1)</code></a></li>
</ul></figcaption>
</figure>
<figure class="variant">
<img src="images/St.split.png" style="width:100%;" alt="split" />
<figcaption><p>
In the distinct <code>StringObservable</code> class (not part of RxJava by default) there is also a
<code>split</code> operator that converts an Observable of Strings into an Observable of Strings that
treats the source sequence as a stream and splits it on a specified regex boundary, then merges the
results of this split.
</p></figcaption>
</figure>

</div>
</div>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/operators/images/MaybeSubject.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/operators/images/SingleSubject.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/operators/images/UnicastSubject.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/operators/images/throttleLatest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3628760

Please sign in to comment.