-
Notifications
You must be signed in to change notification settings - Fork 323
Fix the docs and make the more readable #281
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
Fix the docs and make the more readable #281
Conversation
I can see how removing target typing makes things easier to read in the absence of intellisense, but it shouldn't prevent you from getting started if you just copied the code to an IDE. No strong opinions here, but I wonder if this should reflect a wider policy on target typing in documentation, cc @stephentoub @halter73 @gewarren |
For Learn, we tend to use the most modern syntax in code snippets, so we do use |
I’m not questioning the syntax used in the project code itself. However, for those of us reading the documentation—especially without diving into the source—it’s not immediately clear what object is being passed. The documentation would benefit from being more explicit, providing clear context and explanations to help readers understand what’s going on without needing to infer from modern syntax like the spread operator or other potentially less intuitive constructs. For the project code, by all means, continue using modern patterns. But in the docs, clarity and completeness should take priority to support a broader range of readers. |
For most of the changes made in this PR, there's no information gained, e.g. There's only a couple where the change actually conveys additional information, e.g. The rest are stylistic preferences and I'd prefer we keep what we have. |
@stephentoub These changes are more for consistency between the documents. If you still don't think there is a value it making the documents consistent, please let me know and I'll revert the changes. |
Thanks. Yeah, let's revert all but the few that actually add information. |
@stephentoub no problem. I undid the changes. |
Motivation and Context
Fix the docs and make them more readable. Using
new() { ... }
syntax does not give the reader all the info in the documentation files.How Has This Been Tested?
Breaking Changes
Types of changes
Checklist
Additional context