Corrected arg description in stellargraph/data/explorer.py::DirectedBreadthFirstNeighbours
#2099
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.
In the overridden method
def run(...)
of theclass DirectedBreadthFirstNeighbours(GraphWalk)
defined in file stellargraph/data/explorer.py, the description had mentioned thatin_size
andout_size
were arguments of typeint
, but the context and the usage of the variables clearly suggests that their typing should belist[int]
.Also the method
def _check_neighbourhood_sizes(...)
of the same class, seems to have completely different argument descriptions, that has been corrected along with some additional information regarding the functionality of the method.Regards,
Dinesh Chukkala