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

Replace inline code samples with snippets #292

Merged
merged 7 commits into from
Nov 27, 2023
Merged

Replace inline code samples with snippets #292

merged 7 commits into from
Nov 27, 2023

Conversation

mikeebowen
Copy link
Collaborator

Closes #282 , closes #283

Copy link
Contributor

Learn Build status updates of commit bad9934:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit bad9934987d65333fd10934530d27c1da84142f3 in branch snippets-extract of repository https://github.com/mikeebowen/open-xml-docs into branch main (commit b8207c97dc80980e12086342cfad1c41b9881667). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Collaborator

@twsouthwick twsouthwick left a comment

Choose a reason for hiding this comment

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

LGTM - a couple of style choices, but just want to make sure that the nested snippets aren't shown in the outer snippet when extracted to the docs

theSheets = document?.WorkbookPart?.Workbook.Sheets;
// </Snippet5>
Copy link
Collaborator

Choose a reason for hiding this comment

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

How does this look for snippet 4? does it remove the Snippet5 comment?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, the tags remove all other tags as well as themselves. That's why the last sample showing the complete code has to be in a surrounding all the code, if you just point the sample at the whole file then the comments showing the tags are not removed.

@twsouthwick
Copy link
Collaborator

in the future, it will be helpful to have the title include the sample it's reworking

Copy link
Collaborator

@twsouthwick twsouthwick left a comment

Choose a reason for hiding this comment

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

LGTM

@twsouthwick twsouthwick merged commit 021771f into OfficeDev:main Nov 27, 2023
2 checks passed
@mikeebowen mikeebowen deleted the snippets-extract branch November 28, 2023 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants