generated from readthedocs/tutorial-template
-
-
Notifications
You must be signed in to change notification settings - Fork 10
[Docs] Add some English quirks #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to know the name of these.
We may want to genuinely discourage noun adjuncts in the near future. We contributors use it a lot. As programmers, we write the docs most similarly to how we speak, via shorthands. The problem is, this results in some combination of words that are genuinely incomprehensible for first-time readers, or worse, completely unreadable for localization purposes.
Of course, you know as well as me that there's plenty of situations where they make text easier to digest, if used appropriately.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would be a very odd restriction, very unnatural use of English IMO, and having "list of nodes" might not be very cumbersome there would be far more awkward constructions otherwise
If you have any good examples of cases where it hurts readability that would be good to look into, but I can't think of any, you'd have "the transforms of nodes that are children of this node" instead of "the child node transforms"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Node adjuncts are common in various languages as well, it's not just a thing in English
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be honest, finding actual examples for me is difficult, because I've gone through many of them and attempted to fix them manually in my language, personally.
But I guess as short examples (albeit weak ones, as the topic is very advanced), here's the following from RDFramebufferPass and RenderingDevice's documentation
In these descriptions, the most layman way to decompose this series of words would be, for example, "Description of attachment of pass of the framebuffer". There is no exact correlation or way to infer how exactly these terms are related with one another, they just are. Of course, it may be possible to infer it from the surrounding context, but not always, let alone for any reader outside of the field of expertise.
To be clearer, potentially stacking multiple noun adjuncts is what is particularly problematic here. They make the relationship between words vague and way too up to interpretation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would be a good example of ones to break up a bit, but they are few and far between, each could be fixed by replacing one of the steps, I don't think "Description of the framebuffer pass attachment" is a problem, "description of the attachment of the pass of the framebuffer" is far too verbose IMO (skipping the definite article is ungrammatical here)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, fine. Receipts, albeit opinionated ones. Keep in mind that these, by themselves, are not necessarily a problem, but when compounded by the aforementioned readability issues, they most certainly can be.
For example, I've seen both French and Spanish mistranslating some words because they're written this way. Again, finding concrete examples is very difficult after casually dealing with them manually.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these can absolutely be improved, but translations are probably more an expression of translations being done by people who don't know English well enough to perform translations in some cases, but still relevant to aid in that process as we can't assume high proficiency of translators necessarily