added note about FeatureSet equality #294
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
| @@ -23,7 +23,8 @@ class FeatureSet(object): | |||
|
|
|||
| """ | |||
| Encapsulation of all of the features, values, and metadata about a given | |||
| set of data. | |||
| set of data. Note that FeatureSets can only be equal if the order of | |||
There was a problem hiding this comment.
Nitpick: Should probably use sphinx syntax for this:
.. note::
FeatureSets can only be equal if the order of the instances is identical
because these are stored as lists/arrays.Might even be worth doing .. warning.
| @@ -24,6 +24,8 @@ class FeatureSet(object): | |||
| """ | |||
| Encapsulation of all of the features, values, and metadata about a given | |||
| set of data. | |||
| warning:: FeatureSets can only be equal if the order of the instances is | |||
There was a problem hiding this comment.
Almost! You want this to be:
Encapsulation of all of the features, values, and metadata about a given
set of data.
.. warning::
FeatureSets can only be equal if the order of the instances is identical
because these are stored as lists/arrays.
desilinguist
added a commit
that referenced
this pull request
Feb 15, 2016
…_documentation_on_featureset_order Added note about FeatureSet equality
desilinguist
deleted the
feature/update_documentation_on_featureset_order
branch
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.
Minor update to FeatureSet class documentation. Not sure whether it should go anywhere else.