Documentation fixes #2116
Merged
Documentation fixes #2116
Conversation
This file contains 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
mikee47
force-pushed
the
fix/documentation
branch
from
e21209b to
abbb0ec
Compare
mikee47
changed the title
|
You can browse the resulting documentation for this PR at https://smingdev.readthedocs.io/en/fix-documentation/ |
Otherwise cannot then omit members, which for stream documentation makes it unusable.
Don't repeat comments from inherited classes unless there is something to add. This means we must explicitly add `:members:` declarations if required.
mikee47
force-pushed
the
fix/documentation
branch
from
b06d292 to
fcd30e9
Compare
|
@mikee47 Ping me when this PR is ready. |
|
@slaff All done, thanks. |
slaff
reviewed
Oct 19, 2020
| :cpp:class:`IDataSourceStream` is used where read-only access is required. | ||
| It introduces the :cpp:func:`IDataSourceStream::readMemoryBlock` method which | ||
| performs a regular read without updating the stream position. | ||
| This allows optimistic reading and re-sending, but cannot be handle by some stream |
There was a problem hiding this comment.
but cannot be handle by some stream
Did you mean "but cannot be handled by some stream" ?
|
Ready? |
|
Yep. Hit it! |
mikee47
added a commit
to mikee47/Sming
that referenced
this pull request
Oct 20, 2020
Premature as PR hasn't been submitted yet! This will end up in 4.1 -> 4.2.
slaff
pushed a commit
that referenced
this pull request
Oct 20, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@kmihaylov Re #2106 I've included a basic README for the CS5460 library, if you'd like to add anything you could do it here!