Skip to content
This repository has been archived by the owner on Mar 8, 2020. It is now read-only.

Docs readability improvements #265

Merged
merged 3 commits into from
Jul 11, 2019
Merged

Conversation

ncordon
Copy link
Member

@ncordon ncordon commented Jul 5, 2019

Some typos and grammar corrections. This includes changes for the gRPC usage example which is outdated #227


This change is Reviewable

Copy link
Member

@dennwc dennwc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 3 of 3 files at r1.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @ncordon)


using-babelfish/grpc-usage-example.md, line 62 at r1 (raw file):

The code in the previous section returned a `ParseResponse` object that will have the format of the [ParseResponse](babelfish-protocol.md#ParseResponse) as seen on the [server protocol](babelfish-protocol.md) page. You should check the `status` \(`Status` in the case of Go, since public members start with uppercase\); only a value of `protocol.Status.OK` will indicate success.

The most important member of the `ParseResponse` object is undoubtedly `uast` \(`UAST` in Go\). This will contain a `Node` object with the [structure detailed in the previous page](babelfish-protocol.md#Nodes). This first node returned would be the root node of the UAST, and you typically would iterate over the children node \(contained in the aptly named `children` field\) typically using [a visitor](https://en.wikipedia.org/wiki/Visitor_pattern) and reading the `token`s and `role`s in the tree to do your tool.

Should be either "children nodes" or "node's children"

Copy link
Member

@dennwc dennwc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rebase instead of merging master into the dev branch.

Reviewed 1 of 1 files at r2, 1 of 4 files at r3, 1 of 7 files at r5, 1 of 1 files at r6.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @ncordon)

Signed-off-by: ncordon <nacho.cordon.castillo@gmail.com>
Signed-off-by: ncordon <nacho.cordon.castillo@gmail.com>
@ncordon
Copy link
Member Author

ncordon commented Jul 9, 2019

Please rebase instead of merging master into the dev branch.

Done!

@ncordon
Copy link
Member Author

ncordon commented Jul 9, 2019


using-babelfish/grpc-usage-example.md, line 62 at r1 (raw file):

Previously, dennwc (Denys Smirnov) wrote…

Should be either "children nodes" or "node's children"

True, changed now

Copy link
Member

@dennwc dennwc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but it's still marked as draft, so I cannot really approve it :)

Reviewed 1 of 1 files at r8.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@bzz
Copy link
Contributor

bzz commented Jul 10, 2019

@ncordon it seems like DCO sign-off is missing from 61eaf52

Signed-off-by: ncordon <nacho.cordon.castillo@gmail.com>
@ncordon ncordon marked this pull request as ready for review July 10, 2019 18:05
@ncordon
Copy link
Member Author

ncordon commented Jul 10, 2019

@ncordon it seems like DCO sign-off is missing from 61eaf52

Not the first time it has happened to me 🙈

Copy link
Member

@dennwc dennwc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI failure unrelated, :lgtm:

Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@dennwc dennwc merged commit 7a24be2 into bblfsh:master Jul 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants