[
https://issues.apache.org/jira/browse/GEODE-7956?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17117277#comment-17117277
]
ASF GitHub Bot commented on GEODE-7956:
---------------------------------------
davebarnes97 commented on a change in pull request #5159:
URL: https://github.com/apache/geode/pull/5159#discussion_r430518430
##########
File path: geode-docs/basic_config/data_regions/region_naming.html.md.erb
##########
@@ -24,7 +24,7 @@ follow these region naming guidelines.
- Permitted characters within region names are alphanumeric characters
(`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789`),
-the underscore character (`_`), and the hyphen character (`-`).
+the dot character (`.`), the underscore character (`_`), the square brackets
characters (`[, ]`) and the hyphen character (`-`).
Review comment:
Good clarification. An editorial suggestion: Since you've already
established that you're talking about characters, you can simplify the language
for readability without loss of precision.
Please change "the dot character" to "period", "the underscore character" to
"underscore", "the square brackets characters" to "square brackets" and "the
hyphen character" to "hyphen". Also for readability, "Permitted characters
within region names" could be "Characters permitted in region names are".
The result would be:
Characters permitted in region names are alphanumeric characaters
(`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789`), period
(`.`), underscore (`_`), square brackets (`[, ]`) and hyphen (`-`).
##########
File path: geode-docs/basic_config/data_regions/region_naming.html.md.erb
##########
@@ -24,7 +24,7 @@ follow these region naming guidelines.
- Permitted characters within region names are alphanumeric characters
(`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789`),
-the underscore character (`_`), and the hyphen character (`-`).
+the dot character (`.`), the underscore character (`_`), the square brackets
characters (`[, ]`) and the hyphen character (`-`).
Review comment:
Good clarification. An editorial suggestion: Since you've already
established that you're talking about characters, you can simplify the language
for readability without loss of precision.
Please change "the dot character" to "period", "the underscore character" to
"underscore", "the square brackets characters" to "square brackets" and "the
hyphen character" to "hyphen". Also for readability, "Permitted characters
within region names are" could be "Characters permitted in region names are".
The result would be:
Characters permitted in region names are alphanumeric characaters
(`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789`), period
(`.`), underscore (`_`), square brackets (`[, ]`) and hyphen (`-`).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Correct documentation of legal region names
> -------------------------------------------
>
> Key: GEODE-7956
> URL: https://issues.apache.org/jira/browse/GEODE-7956
> Project: Geode
> Issue Type: Bug
> Components: docs
> Reporter: Darrel Schneider
> Assignee: Mario Kevo
> Priority: Major
>
> According to this:
> https://geode.apache.org/docs/guide/111/basic_config/data_regions/region_naming.html
> region names can only contain alphanumeric, dash, and underscore.
> But the product also supports a dot '.'.
> See RegionNameValidation and RegionNameValidationTest
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
