Add a warning to the CreateContentFromBlueprint method xml docs
#19542
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds a warning remark to the XML documentation of the CreateContentFromBlueprint method to alert users about the need to trigger a notification for regenerating block ids when saving content from a blueprint.
- Added a warning remark in IContentService.cs.
- Added an tag in ContentService.cs that may inherit the updated XML docs.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Umbraco.Core/Services/IContentService.cs | Adds a warning remark to the XML docs for the CreateContentFromBlueprint method. |
| src/Umbraco.Core/Services/ContentService.cs | Updates the method implementation to inherit XML docs via . |
Comments suppressed due to low confidence (1)
src/Umbraco.Core/Services/ContentService.cs:3630
- Ensure that the inherited XML documentation includes the new warning remarks from the interface. If there is any risk that documentation generators may omit this note, consider adding the warning explicitly here.
/// <inheritdoc />
AndyButland
approved these changes
Jun 13, 2025
There was a problem hiding this comment.
Thanks @lauraneto. Looks good to me and is a sensible approach for 13 I believe.
AndyButland
deleted the
v13/bugfix/19352-CreateContentFromBlueprint-does-not-replace-block-ids
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #19352
A proper fix was done for V16 in #19528, but for V13 it would be more tricky as we wouldn't want to introduce new methods or a behavioral change. Instead, a remark was added to the method's xml docs to warn users.