Update the nuget package description to include typical usage, for example settings

[xuzhg]

For example, update this line at: https://github.com/microsoft/OpenAPI.NET.OData/blob/master/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.Release.nuspec#L9

TO include the description about the usage.

[unchase]

@xuzhg You should add not only the description to the .nuspec, but also xml-comments in the library code, so that can see the description for the OpenApiConvertSettings (for each option like EnableKeyAsSegment and others) through intellisence for those who use the Microsoft.OpenApi.OData library.

[xuzhg]

@unchase

Thanks.
In the source code, I have the comments at https://github.com/microsoft/OpenAPI.NET.OData/blob/master/src/Microsoft.OpenApi.OData.Reader/OpenApiConvertSettings.cs#L26. So, is it same as the your xml-comments ?

[unchase]

@xuzhg Yes, but you should include xml-file to project:

and add to .nuspec-file

OpenAPI.NET.OData/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.Release.nuspec

Line 24 in ff05752

<file src="$ProductRoot$\netstandard2.0\Microsoft.OpenApi.OData.Reader.dll" target="lib\netstandard2.0" />

:

<file src="$ProductRoot$\net472\Microsoft.OpenApi.OData.Reader.xml" target="lib\net472" />
<file src="$ProductRoot$\netstandard2.0\Microsoft.OpenApi.OData.Reader.xml" target="lib\netstandard2.0" />

Now i can't see description with intellisence:

[xuzhg]

I see, thanks.

[xuzhg]

@unchase,

I had a fix for this at: e013561

Would you please try this nightly,
https://www.myget.org/feed/openapiodata/package/nuget/Microsoft.OpenApi.OData/1.0.2-Nightly202006041829

To connect to OpenAPI.OData.reader nightly feed, use this URL source https://www.myget.org/F/openapiodata/api/v3/index.json.

[unchase]

@unchase,

I had a fix for this at: e013561

Would you please try this nightly,
https://www.myget.org/feed/openapiodata/package/nuget/Microsoft.OpenApi.OData/1.0.2-Nightly202006041829

To connect to OpenAPI.OData.reader nightly feed, use this URL source https://www.myget.org/F/openapiodata/api/v3/index.json.

@xuzhg All good:

[xuzhg]

@unchase Cool.
Close it as fixed.