Skip to content
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 quick-protection-app-initialization-cpp.md #1529

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lvkv
Copy link
Contributor

@lvkv lvkv commented May 22, 2023

Hi team Azure! Just like #1426 and #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!

@ShannonLeavitt
Copy link
Contributor

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

@lvkv
Copy link
Contributor Author

lvkv commented May 23, 2023

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

@lvkv
Copy link
Contributor Author

lvkv commented May 25, 2023

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

@prmerger-automator
Copy link
Contributor

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

@lvkv
Copy link
Contributor Author

lvkv commented May 25, 2023

@ShannonLeavitt good to go!

@ShannonLeavitt
Copy link
Contributor

@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

@prmerger-automator prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label May 25, 2023
@lvkv
Copy link
Contributor Author

lvkv commented Jul 24, 2023

Any updates on this?

@ShannonLeavitt
Copy link
Contributor

@msmbaldwin

Can you review this old PR?

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

@lvkv
Copy link
Contributor Author

lvkv commented Aug 29, 2023

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

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.

None yet

3 participants