8000 Add missing documentation for DSA types by bartonjs · Pull Request #3498 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]

8000
Skip to content

Conversation

@bartonjs
Copy link
Member

No description provided.

@bartonjs
Copy link
Member Author

cc: @carlossanlop

@carlossanlop carlossanlop self-requested a review November 14, 2019 23:44
@carlossanlop carlossanlop added 🏁 Release: .NET Core 2.x Identifies work items for the .NET Core 2.x releases new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews labels Nov 14, 2019
@carlossanlop carlossanlop added this to the November 2019 milestone Nov 14, 2019
Copy link
Contributor
@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Thanks for making the change, @bartonjs. I left a couple of questions and a couple of nit suggestions for you to consider.

Copy link
Contributor
@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

Looks great @bartonjs. Left a few comments for you to consider. (some are cosmetic to avoid the CI tool to touch these files in the next run. Others seem cosmetic but they look broken if not fixed such as the indented -or-).

@mairaw mairaw removed the waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews label Nov 15, 2019
Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com>
Copy link
Contributor
@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Looks good, no build warnings. Pending to answer the seealso vs altmember question, but I think it looks good to merge.

@carlossanlop
Copy link
Contributor

@mairaw I'll merge. If we have to change the seealso into an altmember, let me know and I can do it separately.

@carlossanlop carlossanlop requested a review from mairaw November 21, 2019 23:44
@mairaw
Copy link
Contributor
mairaw commented Nov 22, 2019

There are some warnings here. Please don't merge yet.

@carlossanlop
Copy link
Contributor

I'll take a look at them soon, @mairaw

<paramref name="handle" /> is <see cref="F:System.IntPtr.Zero"/>.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="handle"/> is not a valid <c>DSA*</c>.</exception>
<altmember cref="P:System.Security.Cryptography.SafeEvpPKeyValue.OpenSslVersion" />
Copy link
Contributor
@carlossanlop carlossanlop Nov 23, 2019

Choose a reason for hiding this comment

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

build warning due to malformed DocId.

The SafeEvpPKeyValue class should've been SafeEvpPKeyHandle:

Suggested change
<altmember cref="P:System.Security.Cryptography.SafeEvpPKeyValue.OpenSslVersion" />
<altmember cref="P:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion" />

</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="parameters"/> does not represent a valid DSA key parameter set.</exception>
<altmember cref="M:System.Security.Cryptography.DSA.Create(System.Security.Cryptography.DSA.Create(System.Security.Cryptography.DSAParameters)" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Malformed DocId. There's a Create call inside the Create call. I removed all the similar instances in this file.

@mairaw mairaw merged commit 645dfb9 into dotnet:master Nov 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🏁 Release: .NET Core 2.x Identifies work items for the .NET Core 2.x releases new-content Indicates PRs that contain new articles

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

0