Azure-RMSDocs icon indicating copy to clipboard operation
Azure-RMSDocs copied to clipboard

Update quick-protection-app-initialization-cpp.md

Open lvkv opened this issue 2 years ago • 9 comments

Hi team Azure! Just like https://github.com/MicrosoftDocs/Azure-RMSDocs/pull/1426 and https://github.com/MicrosoftDocs/Azure-RMSDocs/pull/1412, I've made a number of changes to the MIP SDK's C++ Quickstarts.

Note that these changes are necessary to compile and run your quickstart. As it currently currently written, your code does not compile because of typos, mismatched variable names, and other errors. These changes fix it all:

  • Change incorrectly-named mAppInfo to appInfo
  • Change mipContext.Shutdown() to mipContext->ShutDown() (note the -> and capital D)

I've also made a number of sorely-needed improvements to the readability of this document:

  • Remove comment referencing ReleaseAllResources(), which appears to be a C# method that was accidentally copy-pasted here
  • Removed std::foo and mip::foo namespace qualification when using foo; was already specified. For example, the current documentation specifies using std::make_shared;, then proceeds to call it with a qualifying std:: anyways... this appears to be because of copy-pasting
  • Alphabetize using directives; this has the added benefit of putting the more important using mip:: directives above the less important std ones
  • Commit to using auto type specifiers instead of the current, seemingly random mixture of auto and non-auto
  • Use a conventional '\n' newline instead of the confusing "'\n" seen here

Finally, I've compiled and tested these changes on Windows and Linux, and feel free to ask questions and/or request changes. Thanks again for the work you've put into MPIP/AIP/RMS!

lvkv avatar May 22 '23 20:05 lvkv

@lvkv - Could you please take a moment to agree to the CLA above? We can't review the PR until the CLA is completed.

ShannonLeavitt avatar May 23 '23 16:05 ShannonLeavitt

@ShannonLeavitt currently waiting on employer approval for the CLA. Shouldn't be too long!

lvkv avatar May 23 '23 17:05 lvkv

@microsoft-github-policy-service agree company="D. E. Shaw & Co., L.P."

lvkv avatar May 25 '23 19:05 lvkv

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

prmerger-automator[bot] avatar May 25 '23 19:05 prmerger-automator[bot]

@ShannonLeavitt good to go!

lvkv avatar May 25 '23 19:05 lvkv

@msmbaldwin

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

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

ShannonLeavitt avatar May 25 '23 20:05 ShannonLeavitt

Any updates on this?

lvkv avatar Jul 24 '23 17:07 lvkv

@msmbaldwin

Can you review this old PR?

@MicrosoftDocs/public-repo-pr-review-team

ShannonLeavitt avatar Jul 24 '23 19:07 ShannonLeavitt

Hi, just checking in! I’d like to point teammates at these docs for onboarding, but it’s hard to do that when these intro examples don’t compile

lvkv avatar Aug 29 '23 02:08 lvkv