Update documentation markup #274
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
March 11, 2017 09:01
- `Signal`, `SignalProducer` & `Scheduler` classes have preconditions documented; - added a note about how `DisposableHandle` instances can be created; - added missing `/` to `Reactive` initialiser's documentation; - added missing documentation to `Atomic`'s transition methods;
andersio
requested changes
Mar 28, 2017
Sources/Atomic.swift
Outdated
| /// | ||
| /// - parameters: | ||
| /// - expected: The expected state. | ||
| /// - next:The state to transition to. |
Member
There was a problem hiding this comment.
A missing space between : and The.
Sources/Disposable.swift
Outdated
| /// CompositeDisposable. | ||
| /// `CompositeDisposable`. | ||
| /// | ||
| /// - note: Use `add(_:)` methods of `CompositeDisposable` instance to |
Member
There was a problem hiding this comment.
One does not intentionally create a handle though... Perhaps should it be phrased as "add returns a handle" instead?
Author
|
Pushed some more updates including requested changes. |
eimantas
changed the title
Contributor
|
How did this not get merged earlier?! Sorry @eimantas! |
Author
|
No worries! I managed to forget about this PR myself .) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signal,SignalProducer&Schedulerclasses have preconditionsdocumented;
DisposableHandleinstances can be created;/toReactiveinitialiser's documentation;Atomic's transition methods;