spmallette commented on code in PR #3121: URL: https://github.com/apache/tinkerpop/pull/3121#discussion_r2113770463
########## docs/src/upgrade/release-3.8.x.asciidoc: ########## @@ -30,6 +30,12 @@ complete list of all the modifications that are part of this release. === Upgrading for Users +==== Auto promotion of number types Review Comment: When writing documentation, It often helps to show the before and after behavior. Like, provide a Gremlin Console session showing how it behaved in prior versions and then how the output looks in the current version. This section would benefit from that. Here's an example: https://tinkerpop.apache.org/docs/current/upgrade/#_string_manipulation_steps also, it doesn't look like these lines are hard wrapped we tend to add line breaks with the docs. finally, upgrade docs should reference the JIRA if there is one. i think there's one for this. it also would help if that JIRA was referenced in the title of this PR or else none of the automation links it back over there. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
