4

This Nuspec reference explains the description and summary text fields: https://docs.nuget.org/create/nuspec-reference

In regards to the summary it says it is

A short description of the package. If specified, this shows up in the middle pane of the Add Package Dialog. If not specified, a truncated version of the description is used instead.

Does anyone know the max length of the summary, description, and how many characters from the description will be used if the summary is not provided?

John
  • 29,788
  • 18
  • 89
  • 130
jakejgordon
  • 4,008
  • 7
  • 36
  • 45

2 Answers2

4

There is no maximum length of the summary or description. If no summary is used then all of the description is used.

However what gets displayed is based on the size of the Manage Packages dialog, the size of characters used in the text, whether the row is selected and the Install button is showing, whether you are using Visual Studio 2015 or an older version. So there is not a defined number of characters defined as the maximum length.

Matt Ward
  • 47,057
  • 5
  • 93
  • 94
3

It seems to be client implementation specific. For example, I just got an error from nuget.org's Web API while uploading some packages with long descriptions.

Tags and descriptions cannot be longer than 4000 chars for nuget.org.

enter image description here enter image description here

Summaries vary on the client as well. For example, the package manager console in Visual Studio uses the width of the console window to determine the length of the summary, while the Visual Studio 2017 Package Manager is about 197 chars. Nuget.org uses 297 chars at the moment.

BonzoFestoon
  • 181
  • 1
  • 2
  • 12
  • Source for nuget.org states 4k max length for their website https://learn.microsoft.com/en-us/nuget/reference/nuspec – John Jan 23 '23 at 16:14