-
Notifications
You must be signed in to change notification settings - Fork 6k
update some entries in glossary #2881
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
Conversation
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.
LGTM, modulo some comments/questions. Also, please remove the BOM from the beginning of the file, otherwise the metadata section doesn't render correctly.
docs/standard/glossary.md
Outdated
@@ -193,9 +193,9 @@ You can think of this technology as a persistent JIT compiler. It usually compil | |||
|
|||
## package | |||
|
|||
For a package-based target framework, a NuGet package that contains an assembly of the same name. | |||
A NuGet package — or just a package — is a *.zip* file with one or more asemblies of the same name along with additional metadata such as the author name. |
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.
typo: asemblies
docs/standard/glossary.md
Outdated
|
||
The package is a *.zip* file wih a *.nupkg* extension that may contain assets (such as *.dll* files and *.xml* files) for use with multiple frameworks and versions. When installed in an app or library, the appropriate assets are selected based on the target framework specified by the app or library. The assets that define the interface are in the *ref* folder, and the assets that define the implementation are in the *lib* folder. | ||
The *.zip* file has a *.nupkg* extension and may contain assets (such as *.dll* files and *.xml* files) for use with multiple frameworks and versions. When installed in an app or library, the appropriate assets are selected based on the target framework specified by the app or library. The assets that define the interface are in the *ref* folder, and the assets that define the implementation are in the *lib* folder. |
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.
should we replace parentheses with commas? Acrolinx usually complains about those.
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.
A few suggestions to consider. Also, it may eliminate confusion if we use ".NET Core" instead of the ".NET Core framework" heading. It's too close to ".NET Framework".
@@ -35,6 +35,12 @@ A cross-platform, high-performance, open source implementation of ASP.NET built | |||
|
|||
See [ASP.NET Core](/aspnet/#pivot=core). | |||
|
|||
## assembly | |||
|
|||
A *.dll* file that contains a collection of APIs that can be called by apps or other assemblies. |
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.
Should we mention somewhere in this section that an assembly is also commonly referred to as a "binary"?
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.
What is the context in which it's common to use "binary" in the sense of "assembly"?
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 often hear folks referring to the .dll files in the bin folder as their project's binaries after they've built a project in VS.
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 see that you already added. We even have that in the CLI commands reference.
https://github.com/dotnet/docs/search?l=Markdown&q=binaries&type=&utf8=%E2%9C%93
docs/standard/glossary.md
Outdated
A *.dll* file that contains a collection of APIs that can be called by apps or other assemblies. | ||
|
||
A .NET assembly is a collection of types. An assembly includes interfaces, classes, structures, enumerations, and delegates. See also [library](#library). | ||
|
||
## CLR | ||
|
||
Common language runtime. |
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.
Common language runtime --> Common Language Runtime
Scott Hanselman had some suggestions and I've tried to implement them -- @mairaw @BillWagner @rpetrusha what do you think of these changes?