Merged
Conversation
More natural native English.
1. Changed typo 'or' to 'of'. 2. Reword section on conan install installing debug versions of libraries. Suggest that using the general meaning of installing while talking about the conan install command is confusing so hopefully it is more obvious to be explicit about the local cache. 3. Remove caption 'Windows' from platform agnostic conan command.
Reword description of layout method. A sentence starting with 'Things like', makes it difficult to detect the verb and one is not sure whether it refers back to the previous sentence.
Remove a 'that' and replace with 'to how' for more natural English.
Insert missing word 'how'. 'We explain to use' becomes 'We explain how to use'.
'constraint' is a noun - 'to constraint' replaced with 'to constrain'.
Reword the 'Be aware' paragraph; it was not clear that the 'or' was mutually exclusive. Reword the phrasing about an exception being raised though it is still not clear whether the warning mentioned at the end of the paragraph is the same as the exception or not. Replace 'where conditions meet' with 'where conditions are met' for more idiomatic English.
Replace 'This steps' with 'These steps' - typo.
Change text about testing. It was confusing, think is says what it was meant to say now. Add some missing words in other sections.
|
|
memsharded
approved these changes
Feb 6, 2024
Member
memsharded
left a comment
memsharded
left a comment
There was a problem hiding this comment.
Looks good, thanks very much for taking the time to improve the docs!
Co-authored-by: James <memsharded@gmail.com>
AbrilRBS
approved these changes
Feb 6, 2024
czoido
approved these changes
Feb 7, 2024
czoido
pushed a commit
that referenced
this pull request
Feb 7, 2024
* Update build_simple_cmake_project.rst More natural native English. * Update different_configurations.rst 1. Changed typo 'or' to 'of'. 2. Reword section on conan install installing debug versions of libraries. Suggest that using the general meaning of installing while talking about the conan install command is confusing so hopefully it is more obvious to be explicit about the local cache. 3. Remove caption 'Windows' from platform agnostic conan command. * Update create_your_first_package.rst Reword description of layout method. A sentence starting with 'Things like', makes it difficult to detect the verb and one is not sure whether it refers back to the previous sentence. * Update add_dependencies_to_packages.rst Remove a 'that' and replace with 'to how' for more natural English. * Update preparing_the_build.rst Insert missing word 'how'. 'We explain to use' becomes 'We explain how to use'. * Update configure_options_settings.rst 'constraint' is a noun - 'to constraint' replaced with 'to constrain'. * Update configure_options_settings.rst Reword the 'Be aware' paragraph; it was not clear that the 'or' was mutually exclusive. Reword the phrasing about an exception being raised though it is still not clear whether the warning mentioned at the end of the paragraph is the same as the exception or not. Replace 'where conditions meet' with 'where conditions are met' for more idiomatic English. * Update configure_options_settings.rst Replace 'This steps' with 'These steps' - typo. * Update build_packages.rst Change text about testing. It was confusing, think is says what it was meant to say now. Add some missing words in other sections. * Update tutorial/creating_packages/build_packages.rst Co-authored-by: James <memsharded@gmail.com> * Update tutorial/creating_packages/build_packages.rst --------- Co-authored-by: Rubén Rincón Blanco <git@rinconblanco.es> Co-authored-by: James <memsharded@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This pull request mostly corrects typos and adds missing words in the sections about consuming and creating packages. It also restructures some paragraphs where I, as a native English speaker could see two or three possible meanings for the original or found the original difficult to understand. If I have still misunderstood perhaps this can serve to show how and where the original could be improved.