Skip to content

Documentation typos. Fixes #13 #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions reference/Algorithm.h/Changed.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: OnChanged
title: Changed
type_tag: function
groups:
- {name: Home, url: ''}
Expand All @@ -17,8 +17,8 @@ template
typename D,
typename S
>
Events<D,Token> OnChangedTo(const Signal<D,S>& target);
Events<D,Token> Changed(const Signal<D,S>& target);
{% endhighlight %}

## Semantics
Creates a token stream that emits when `target` is changed.
Creates a token stream that emits when `target` is changed.
4 changes: 2 additions & 2 deletions reference/Algorithm.h/ChangedTo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: OnChangedTo
title: ChangedTo
type_tag: function
groups:
- {name: Home, url: ''}
Expand All @@ -18,7 +18,7 @@ template
typename V,
typename S = decay<V>::type
>
Events<D,Token> OnChangedTo(const Signal<D,S>& target, V&& value);
Events<D,Token> ChangedTo(const Signal<D,S>& target, V&& value);
{% endhighlight %}

## Semantics
Expand Down
6 changes: 3 additions & 3 deletions tutorials/BasicAlgorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public:
USING_REACTIVE_DOMAIN(D)

EventSourceT<int> Samples = MakeEventSource<int>();
SignalT<int> LastSample = Hold(Samples);
SignalT<int> LastSample = Hold(Samples, 0);
};
{% endhighlight %}
{% highlight C++ %}
Expand Down Expand Up @@ -173,13 +173,13 @@ public:
USING_REACTIVE_DOMAIN(D)

EventSourceT<int> Input = MakeEventSource<D,int>();
Signal<int> Threshold = MakeSignal<D>(10);
SignalT<int> Threshold = MakeVar<D,int>(10);

// ...
};
{% endhighlight %}

We could just use the `Value()` accessor of `Threadhold`:
We could just use the `Value()` accessor of `Threshold`:
{% highlight C++ %}
// Note: This is potentially unsafe
SignalT<vector<int>> CriticalSamples = Iterate(
Expand Down