-
Notifications
You must be signed in to change notification settings - Fork 967
Update CComCoClass
reference page
#5211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update CComCoClass
reference page
#5211
Conversation
@Rageking8 : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
Learn Build status updates of commit 72050b3: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
| Name | Description | | ||
| ---------------------------------------------------------- | ----------------------------------------------------------------------- | | ||
| [CComCoClass::CreateInstance](#createinstance) | (Static) Creates an instance of the class and queries for an interface. | | ||
| [CComCoClass::Error](#error) | (Static) Returns rich error information to the client. | | ||
| [CComCoClass::GetObjectCLSID](#getobjectclsid) | (Static) Returns the object's class identifier. | | ||
| [CComCoClass::GetObjectDescription](#getobjectdescription) | (Static) Override to return the object's description. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we format tables as well, to improve readability of the raw markdown source?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question. I see benefits both ways. I usually don't because it becomes maintenance to keep it that way. As the owner of 10,000 topics I try to reduce maintenance whenever I can.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would think maintenance becomes a factor for tables that update somewhat frequently. Most of these tables never really change in 5+ years, so it might be worth formatting it once and keeping it as such.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It depends on the font in your editor whether the cleaned up version looks cleaned up. And we have editor tools that actually do the opposite and remove all the spaces from tables. I see both versions in our docs. I can see the value both ways. But mostly, I'd prefer not to spend time on PRs that clean up tables because its time I can't really afford for a gain that is nebulous in the scheme of things.
I very much appreciate all the other contributions you make because they add clear customer value and are things I'd have to do myself. You've made ongoing and significant improvements to these docs, for which I thank you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted! Will not format tables in future PRs since there might not be a clear benefit (with potential downsides).
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
#sign-off |
Summary:
cpp
for syntax highlightingbr
elements to escapesms.date
is not updated as the changes are mostly superficial)