Skip to content
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

Package descriptions for CSharp and VB should include summary blurb #22166

Merged
merged 5 commits into from
Sep 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/NuGet/Microsoft.CodeAnalysis.Build.Tasks.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@
<package>
<metadata minClientVersion="3.3">
<id>Microsoft.CodeAnalysis.Build.Tasks</id>
<summary>The build Tasks for running the C# and VB compilers in MSBuild.</summary>
<summary>
The build task and targets used by MSBuild to run the C# and VB compilers.
</summary>
<description>
Contains the build task and targets used by MSBuild to run the C# and VB compilers.
Supports using VBCSCompiler on Windows.
The build task and targets used by MSBuild to run the C# and VB compilers.
Supports using VBCSCompiler on Windows.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I must admit I'm not sure how a customer will understand what VBCSCompiler is, much less how this package supports it on Windows.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know either. I'll leave this one as-is.


$commitPathMessage$
More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
<group targetFramework="netstandard1.3">
Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.CSharp.CodeStyle.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") code style analyzers for C#.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") code style analyzers for C#.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
</dependencies>

Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.CSharp.Features.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") support for creating C# editing experiences.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") support for creating C# editing experiences.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Features" version="$version$" />
<dependency id="Microsoft.CodeAnalysis.CSharp.Workspaces" version="$version$" />
Expand Down
12 changes: 10 additions & 2 deletions src/NuGet/Microsoft.CodeAnalysis.CSharp.Scripting.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>Microsoft.CodeAnalysis.CSharp.Scripting</id>
<summary>Microsoft .NET Compiler Platform ("Roslyn") CSharp scripting package.</summary>
<description>$commitPathMessage$</description>
<summary>
Microsoft .NET Compiler Platform ("Roslyn") CSharp scripting package.
</summary>
<description>
Microsoft .NET Compiler Platform ("Roslyn") CSharp scripting package.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<language>en-US</language>
<requireLicenseAcceptance>true</requireLicenseAcceptance>
<version>$version$</version>
Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.CSharp.Workspaces.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") support for analyzing C# projects and solutions.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") support for analyzing C# projects and solutions.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.CSharp" version="[$version$]" />
<dependency id="Microsoft.CodeAnalysis.Workspaces.Common" version="[$version$]" />
Expand Down
8 changes: 6 additions & 2 deletions src/NuGet/Microsoft.CodeAnalysis.CSharp.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@
<id>Microsoft.CodeAnalysis.CSharp</id>
<summary>
.NET Compiler Platform ("Roslyn") support for C#, Microsoft.CodeAnalysis.CSharp.dll.
</summary>
<description>
.NET Compiler Platform ("Roslyn") support for C#, Microsoft.CodeAnalysis.CSharp.dll.

More details at https://aka.ms/roslyn-packages
</summary>
<description>$commitPathMessage$</description>

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Common" version="[$version$]" />
</dependencies>
Expand Down
9 changes: 7 additions & 2 deletions src/NuGet/Microsoft.CodeAnalysis.Common.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata minClientVersion="3.3">
<id>Microsoft.CodeAnalysis.Common</id>
<summary>A shared package used by the Microsoft .NET Compiler Platform ("Roslyn").</summary>
<summary>
A shared package used by the Microsoft .NET Compiler Platform ("Roslyn").
</summary>
<description>
A shared package used by the Microsoft .NET Compiler Platform ("Roslyn"). Do not install this package manually, it will be added as a prerequisite by other packages that require it.
A shared package used by the Microsoft .NET Compiler Platform ("Roslyn").
Do not install this package manually, it will be added as a prerequisite by other packages that require it.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
Expand Down
8 changes: 6 additions & 2 deletions src/NuGet/Microsoft.CodeAnalysis.Compilers.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata minClientVersion="3.3">
<id>Microsoft.CodeAnalysis.Compilers</id>
<summary>.NET Compiler Platform ("Roslyn")</summary>
<summary>
Compiler layer of the .NET Compiler Platform ("Roslyn").
</summary>
<description>
.NET Compiler Platform ("Roslyn"). Install this package to get both C# and Visual Basic support. Install either of the dependencies directly to get one of the languages separately.
Compiler layer of the .NET Compiler Platform ("Roslyn").
Install this package to get both C# and Visual Basic support.
If you want just support for one language, install Microsoft.CodeAnalysis.CSharp or Microsoft.CodeAnalysis.VisualBasic.

More details at https://aka.ms/roslyn-packages

Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.Debugging.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata minClientVersion="3.3">
<id>Microsoft.CodeAnalysis.Debugging</id>
<summary>Package containing sources of Microsoft .NET Compiler Platform ("Roslyn") debug information encoders and decoders</summary>
<summary>
Package containing sources of Microsoft .NET Compiler Platform ("Roslyn") debug information encoders and decoders.
</summary>
<description>
Package containing sources of Microsoft .NET Compiler Platform ("Roslyn") debug information encoders and decoders.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<language>en-US</language>
<requireLicenseAcceptance>true</requireLicenseAcceptance>
Expand Down
4 changes: 4 additions & 0 deletions src/NuGet/Microsoft.CodeAnalysis.EditorFeatures.Text.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@
.NET Compiler Platform ("Roslyn") support for working with Visual Studio text buffers.
</summary>
<description>
.NET Compiler Platform ("Roslyn") support for working with Visual Studio text buffers.

Supported Platforms:
- .NET Framework 4.6

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
Expand Down
6 changes: 5 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.EditorFeatures.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
<metadata>
<id>Microsoft.CodeAnalysis.EditorFeatures</id>
<summary>
.NET Compiler Platform ("Roslyn") support for editor features inside the Visual Studio editor..
.NET Compiler Platform ("Roslyn") support for editor features inside the Visual Studio editor.
</summary>
<description>
.NET Compiler Platform ("Roslyn") support for editor features inside the Visual Studio editor.

Supported Platforms:
- .NET Framework 4.6

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.Features.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") support for creating editing experiences.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") support for creating editing experiences.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Workspaces.Common" version="$version$" />
</dependencies>
Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.PooledObjects.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata minClientVersion="3.3">
<id>Microsoft.CodeAnalysis.PooledObjects</id>
<summary>Package containing sources of Microsoft .NET Compiler Platform ("Roslyn") pooled objects</summary>
<summary>
Package containing sources of Microsoft .NET Compiler Platform ("Roslyn") pooled objects.
</summary>
<description>
Package containing sources of Microsoft .NET Compiler Platform ("Roslyn") pooled objects.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<language>en-US</language>
<requireLicenseAcceptance>true</requireLicenseAcceptance>
Expand Down
11 changes: 7 additions & 4 deletions src/NuGet/Microsoft.CodeAnalysis.Remote.Razor.ServiceHub.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process.
</summary>
<description>
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process. Do not install this package manually, it will be added as a prerequisite by other packages that require it.
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process.
Do not install this package manually, it will be added as a prerequisite by other packages that require it.

Supported Platforms:
- .NET Framework 4.6

Supported Platforms:
- .NET Framework 4.6
More details at https://aka.ms/roslyn-packages

$commitPathMessage$
$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Remote.Workspaces" version="[$version$]" />
Expand Down
11 changes: 7 additions & 4 deletions src/NuGet/Microsoft.CodeAnalysis.Remote.ServiceHub.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process.
</summary>
<description>
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process. Do not install this package manually, it will be added as a prerequisite by other packages that require it.
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process.
Do not install this package manually, it will be added as a prerequisite by other packages that require it.

Supported Platforms:
- .NET Framework 4.6

Supported Platforms:
- .NET Framework 4.6
More details at https://aka.ms/roslyn-packages

$commitPathMessage$
$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Remote.Workspaces" version="[$version$]" />
Expand Down
11 changes: 7 additions & 4 deletions src/NuGet/Microsoft.CodeAnalysis.Remote.Workspaces.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process.
</summary>
<description>
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process. Do not install this package manually, it will be added as a prerequisite by other packages that require it.
A shared package used by the .NET Compiler Platform ("Roslyn") including support for coordinating analysis of projects and solutions using a separate server process.
Do not install this package manually, it will be added as a prerequisite by other packages that require it.

Supported Platforms:
- .NET Framework 4.6

Supported Platforms:
- .NET Framework 4.6
More details at https://aka.ms/roslyn-packages

$commitPathMessage$
$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Common" version="[$version$]" />
Expand Down
9 changes: 7 additions & 2 deletions src/NuGet/Microsoft.CodeAnalysis.Scripting.Common.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>Microsoft.CodeAnalysis.Scripting.Common</id>
<summary>Microsoft .NET Compiler Platform ("Roslyn") shared scripting package.</summary>
<summary>
Microsoft .NET Compiler Platform ("Roslyn") shared scripting package.
</summary>
<description>
Microsoft .NET Compiler Platform ("Roslyn") shared scripting package. Do not install this package manually, it will be added as a prerequisite by other packages that require it.
Microsoft .NET Compiler Platform ("Roslyn") shared scripting package.
Do not install this package manually, it will be added as a prerequisite by other packages that require it.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
Expand Down
6 changes: 5 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.Scripting.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>Microsoft.CodeAnalysis.Scripting</id>
<summary>Microsoft .NET Compiler Platform ("Roslyn") CSharp and VB scripting package.</summary>
<summary>
Microsoft .NET Compiler Platform ("Roslyn") CSharp and VB scripting package.
</summary>
<description>
Microsoft .NET Compiler Platform ("Roslyn") CSharp and VB scripting package.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") code style analyzers for Visual Basic.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") code style analyzers for Visual Basic.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
</dependencies>

Expand Down
8 changes: 7 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.VisualBasic.Features.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") support for creating Visual Basic editing experiences.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") support for creating Visual Basic editing experiences.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Features" version="$version$" />
<dependency id="Microsoft.CodeAnalysis.VisualBasic.Workspaces" version="$version$" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>Microsoft.CodeAnalysis.VisualBasic.Scripting</id>
<summary>Microsoft .NET Compiler Platform ("Roslyn") Visual Basic scripting package.</summary>
<summary>
Microsoft .NET Compiler Platform ("Roslyn") Visual Basic scripting package.
</summary>
<description>
Microsoft .NET Compiler Platform ("Roslyn") Visual Basic scripting package.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
<summary>
.NET Compiler Platform ("Roslyn") support for analyzing Visual Basic projects and solutions.
</summary>
<description>$commitPathMessage$</description>
<description>
.NET Compiler Platform ("Roslyn") support for analyzing Visual Basic projects and solutions.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.VisualBasic" version="[$version$]" />
<dependency id="Microsoft.CodeAnalysis.Workspaces.Common" version="[$version$]" />
Expand Down
8 changes: 6 additions & 2 deletions src/NuGet/Microsoft.CodeAnalysis.VisualBasic.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@
<id>Microsoft.CodeAnalysis.VisualBasic</id>
<summary>
.NET Compiler Platform ("Roslyn") support for Visual Basic, Microsoft.CodeAnalysis.VisualBasic.dll.
</summary>
<description>
.NET Compiler Platform ("Roslyn") support for Visual Basic, Microsoft.CodeAnalysis.VisualBasic.dll.

More details at https://aka.ms/roslyn-packages
</summary>
<description>$commitPathMessage$</description>

$commitPathMessage$
</description>
<dependencies>
<dependency id="Microsoft.CodeAnalysis.Common" version="$version$" />
</dependencies>
Expand Down
5 changes: 4 additions & 1 deletion src/NuGet/Microsoft.CodeAnalysis.Workspaces.Common.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
A shared package used by the .NET Compiler Platform ("Roslyn") including support for analyzing projects and solutions.
</summary>
<description>
A shared package used by the .NET Compiler Platform ("Roslyn") including support for analyzing projects and solutions. Do not install this package manually, it will be added as a prerequisite by other packages that require it.
A shared package used by the .NET Compiler Platform ("Roslyn") including support for analyzing projects and solutions.
Do not install this package manually, it will be added as a prerequisite by other packages that require it.

More details at https://aka.ms/roslyn-packages

$commitPathMessage$
</description>
Expand Down
Loading