added docs for prefix_number and prefix_street #2172
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iandees
requested changes
Nov 29, 2016
| @@ -221,6 +253,8 @@ _Example_ | |||
| } | |||
| ``` | |||
|
|
|||
| The source data should be examined to determine if the shorthand methods prefix_number and prefix_street could be used instead of regexp. | |||
There was a problem hiding this comment.
Can you add `'s around the function names for clarity.
| @@ -147,7 +147,9 @@ This list gives a brief summary of what each function does. Examples can be foun | |||
|
|
|||
| Function | Note | |||
| -------- | ----- | |||
| `regexp` | Allow regex find and/or replace on a given field. Useful to extract house number/street/city/region etc when the source has them in a single field | |||
| `prefix_number` | Allow number to be extracted from a single field using an internal convenience regex. | |||
There was a problem hiding this comment.
A minor nit: do you think it would make sense to remove reference to it being a regular expression behind the scenes? This way we can swap out the backend implementation with something non-regex-ey later. Or maybe it doesn't matter...
There was a problem hiding this comment.
Yeah — maybe we should provide some example values here instead to show what kind of inputs it works for?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.