Skip to content

Properties for Result class are not documented. #283

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.

Sign up for GitHub

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

Jump to bottom
Closed
13tales opened this issue Sep 3, 2017 · 2 comments
Closed

Properties for Result class are not documented. #283

13tales opened this issue Sep 3, 2017 · 2 comments

Comments

@13tales
Copy link

13tales commented Sep 3, 2017

I've noticed that the Result class documentation has some omissions.
There's no documentation of properties, so it's unclear to a newcomer that (for example) Result.summary.counters is an instance of StatisticsSummary, with the associated convenience methods for returning the number of nodes, relationships, properties modified, etc.
@lutovich
Copy link
Contributor

lutovich commented Sep 3, 2017

Hi @13tales,

Thanks for reporting this oversight. We will try to fix it for the upcoming 1.5 release.

@lutovich lutovich mentioned this issue Sep 18, 2017
Merged
@lutovich
Copy link
Contributor

Hi @13tales,

Please see #287 for updated docs. Website should get updated after merge. Your review would be super welcome :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lutovich @13tales