Update ns-System.Net.Mail.xml #2420
Conversation
Lift the warning from SmtpClient to the namespace to make it clearer this is now obsolete.
There was a problem hiding this comment.
Thanks for submitting this PR, @stephenegriffin. I don't think, though, that adding an IMPORTANT note really calls attention to the fact that SmtpClient is deprecated. I've suggested an alternative.
xml/ns-System.Net.Mail.xml
Outdated
|
|
||
|
|
||
| [!IMPORTANT] | ||
| We don't recommend that you use the `SmtpClient` class for new development. For more information, see [SmtpClient shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0005.md) on GitHub. |
There was a problem hiding this comment.
The formatting here is incorrect to produce a note box. The lines should be preceded by > . But this seems an awkward way of handling the fact that SmtpClient is obsolete in any case. Instead of the note, I'd modify the Remarks section as I've suggested, and also add "(This type is now obsolete.)" to the type summary in dotnet-api-docs/xml/System.Net.Mail/SmtpClient.xml.
xml/ns-System.Net.Mail.xml
Outdated
| <Attribute FrameworkAlternate="xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0"> | ||
| <AttributeName>System.Obsolete("SmtpClient and its network of types are poorly designed, we strongly recommend you use https://github.com/jstedfast/MailKit and https://github.com/jstedfast/MimeKit instead")</AttributeName> | ||
| </Attribute> | ||
| </Attributes> | ||
| <Docs> | ||
| <summary>The <see cref="N:System.Net.Mail" /> namespace contains classes used to send electronic mail to a Simple Mail Transfer Protocol (SMTP) server for delivery.</summary> | ||
| <remarks> | ||
| <format type="text/markdown"><
|
Since you didn't respond, @stephenegriffin, I've incorporated my suggestions into your PR, and also opened #2483 to change the description of SmtpClient. I'll merge your PR now. |
|
Sorry - missed your reply - thanks for following through on this. |
|
Actually - this is all wrong - the point was to indicate that the entire System.Net.Mail namespace is deprecated. You've removed that and added a redundant note to SmtpClient. |
Lift the warning from SmtpClient to the namespace to make it clearer this is now obsolete.
Summary
Describe your changes here.
Fixes #Issue_Number (if available)