justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881164753
########## docs/cli.md: ########## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: The GitHub web UI doesn't work the same way it highlights word changes within a line. We are writing docs in an IDE, and IDE plugins such as grammar checkers help do that. They don't always work if you break sentences over lines. In this project, I noticed that in the documentation that breaks up sentences, errors are easily introduced in changes (as they are here). ########## docs/cli.md: ########## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: The GitHub web UI doesn't work the same way it highlights word changes within a line. We are writing docs in an IDE, and IDE plugins such as grammar checkers help do that. They don't always work if you break sentences over lines. In this project, I noticed that in the documentation that breaks up sentences, errors are easily introduced in changes (as they have been here). -- 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]
