errors: clarify documentation #500

Merged
merged 2 commits into from Feb 9, 2017

Projects

None yet

3 participants

@kr
Member
kr commented Feb 9, 2017

Using these parameter names for Sub seems to make its
behavior clearer.

@kr kr errors: clarify documentation
Using these parameter names for Sub seems to make its
behavior clearer.
d2327a0
@kr
Member
kr commented Feb 9, 2017

PTAL

This also addresses the potential syntax highlighting problem raised in #496 (comment).

@kr kr added the PTAL label Feb 9, 2017
@bobg
Contributor
bobg commented Feb 9, 2017

Actually, root sounds like it's going to be the more deeply buried error. How about newRoot and orig? 🚲 🏠

@kr
Member
kr commented Feb 9, 2017

Let me try to adjust the wording to hopefully make it clearer. (I already wasn't super happy with the existing wording.)

@kr kr simpler and clearer description
c042fac
@kr
Member
kr commented Feb 9, 2017

Ok, updated. There is no "new" and "old" involved. It is just a root from one place and everything else from another place.

@bobg
bobg approved these changes Feb 9, 2017 View changes
@bobg
Contributor
bobg commented Feb 9, 2017

LGTM

@chainbot chainbot merged commit d230de6 into main Feb 9, 2017

3 checks passed

licence/cla Contributor License Agreement is signed.
Details
wercker/cored Wercker pipeline passed
Details
wercker/java Wercker pipeline passed
Details
@chainbot chainbot deleted the root-name branch Feb 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment