dotnet
isCritical .. what are the consequences of a control being critical .. where is the description what this means or the link where this is described
Type of issue
Missing information
Description
The documentation article goes to the extent to just say "The IsCritical property specifies whether the control is critical."
Just naming the property name and converting it into a sentence is not documentation.
What is needed is an explanation of the meaning of isCritical - saying if a control is critical, it has the consequence that this control is <WHAT?>. -> Don't say critical or it says what it is it's obvious .. explain what the consequences are of being critical.
Be explicit what it means when isCritical is true and share the detail on this page.
Being minimalistic and ambiguous and letting a developer make assumptions is the worst outcome you can generate with documentation.
If this documentation already exists (@1) - add the link to this page.
@1 If the documentation does exist, the question is why the link to it has not been added? If the documentation does not exist, the question is why the details have not been added?
Apply this pattern to any page that does the same as the isCritical page.
Page URL
https://learn.microsoft.com/en-us/dotnet/api/system.directoryservices.protocols.directorycontrol.iscritical?view=net-8.0#system-directoryservices-protocols-directorycontrol-iscritical
Content source URL
https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.DirectoryServices.Protocols/DirectoryControl.xml
Document Version Independent Id
601ec5aa-c724-869e-05dc-af99c95a7698
Article author
@dotnet-bot
I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.
I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.