This repository has been archived by the owner on Sep 1, 2023. It is now read-only.
Updating FileRecordStream docstrings #3545
Merged
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
marionleborgne
approved these changes
Apr 13, 2017
src/nupic/data/file_record_stream.py
Outdated
| (line 1), type (line 2), and a special indicator (line 3). The special indicator | ||
| can indicate that the field specifies a reset, is a sequence ID, or is a | ||
| timestamp for the record. | ||
| :class:`~.file_record_stream.FileRecordStream` is class that can read and write |
There was a problem hiding this comment.
FileRecordStream is a class
src/nupic/data/file_record_stream.py
Outdated
| The FileRecordStream class supports the context manager ('with' statement ) | ||
| protocol. That means you con do: | ||
| :class:`~.file_record_stream.FileRecordStream` supports the context manager | ||
| (``with`` statement) protocol. That means you con do: |
src/nupic/data/file_record_stream.py
Outdated
| retval: a data row (a list or tuple) if available; None, if no more records | ||
| in the table (End of Stream - EOS); empty sequence (list or tuple) | ||
| when timing out while waiting for the next record. | ||
| :param useCache: NOT USED |
There was a problem hiding this comment.
Maybe we should just get rid of this?
src/nupic/data/file_record_stream.py
Outdated
| # input bookmark is not applicable in case of a file storage | ||
| inputBookmark = inputBookmark | ||
| :param record: a list of Python objects that will be string-ified | ||
| :param inputBookmark: NOT USED |
src/nupic/data/file_record_stream.py
Outdated
| Returns whether there are more records from current position. ``bookmark`` | ||
| is not used in this implementation. | ||
|
|
||
| :param bookmark: NOT USED |
There was a problem hiding this comment.
Same question as before, ca we remove it since it's not used.
|
@marionleborgne took all your feedback, thanks |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #3542
Blocked by #3541