Skip to content

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

Merged

Conversation

Rageking8
Copy link
Contributor

Summary:

  • Set language of code blocks to cpp for syntax highlighting
  • Format table and some of the code snippets
  • Convert legacy br elements to escapes
  • Update metadata (ms.date is not updated as the changes are mostly superficial)

Copy link
Contributor

@Rageking8 : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 72050b3:

✅ Validation status: passed

File Status Preview URL Details
docs/atl/reference/ccomcoclass-class.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Comment on lines +31 to +36
| 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. |
Copy link
Contributor Author

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?

Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

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.

Copy link
Contributor Author

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).

@ttorble
Copy link
Contributor

ttorble commented Feb 28, 2025

@TylerMSFT

Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged Tracking label for the PR review team label Feb 28, 2025
Copy link
Collaborator

@TylerMSFT TylerMSFT left a comment

Choose a reason for hiding this comment

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

Thank you!

@TylerMSFT
Copy link
Collaborator

#sign-off

@Court72 Court72 merged commit d18d5d5 into MicrosoftDocs:main Feb 28, 2025
2 checks passed
@Rageking8 Rageking8 deleted the update-ccomcoclass-reference-page branch March 1, 2025 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants