Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove reference to all_data property in docstring of class Segment #1270

Merged

Conversation

Moritz-Alexander-Kern
Copy link
Member

This PR removes the reference to the all_data property in the docstring of the neo.core.Segment class.

:all_data: (list) A list of all child objects in the :class:`Segment`.

In pull request #143, the all_data property was removed from the class, but the description of the property remained in the docstring. This could be confusing for users who come across the docstring and try to use the all_data property, which is no longer available.

This change does not affect the functionality of the code, but it will improve the clarity and accuracy of the documentation, which is why I considered to add this here.

Feel free to close this PR any time, this is just meant to inform you about this finding. 🙂

@JuliaSprenger
Copy link
Member

Hi @Moritz-Alexander-Kern Thanks for the cleanup!

@JuliaSprenger JuliaSprenger merged commit 5016695 into NeuralEnsemble:new-docs May 9, 2023
@apdavison apdavison added this to the 0.13.0 milestone Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants