-
Notifications
You must be signed in to change notification settings - Fork 154
Update documentation to match code change for ObservableGroup #394
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 documentation to match code change for ObservableGroup #394
Conversation
|
Docs Build status updates of commit 468abff: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings 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:
|
|
@vgromfeld @michael-hawker can one of you look into this why it is not building? |
## Fixes #3519 <!-- Add the relevant issue number after the "#" mentioned above (for ex: Fixes #1234) which will automatically close the issue once the PR is merged. --> <!-- Add a brief overview here of the feature/bug & fix. --> Removes two restrictions from `ObservableGroup` to make it usable in more situations. In my case, I wanted to be able to rename the groups (for this I needed a mutable key), and I wanted to add properties on the group level (I needed to unseal it) - Removes the immutable restriction on the `Key` property and makes the `Key` property observable. - Removes the `sealed` keyword from `ObservableGroup` ## PR Type What kind of change does this PR introduce? <!-- Please uncomment one or more that apply to this PR. --> <!-- - Bugfix --> - Feature <!-- - Code style update (formatting) --> <!-- - Refactoring (no functional changes, no api changes) --> <!-- - Build or CI related changes --> <!-- - Documentation content changes --> <!-- - Sample app changes --> <!-- - Other... Please describe: --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. --> `ObservableGroup` has an immutable `Key` property `ObservableGroup` is not inheritable ## What is the new behavior? <!-- Describe how was this issue resolved or changed? --> `ObservableGroup` has a mutable `Key` property `ObservableGroup` is inheritable ## PR Checklist Please check if your PR fulfills the following requirements: - [ ] Tested code with current [supported SDKs](../readme.md#supported) - [x] Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: MicrosoftDocs/WindowsCommunityToolkitDocs#394 - [x] Sample in sample app has been added / updated (for bug fixes / features) --> _no update needed_ - [x] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/windows-toolkit/WindowsCommunityToolkit-design-assets) --> _not applicable_ - [x] Tests for the changes have been added (for bug fixes / features) (if applicable) --> _not applicable_ - [x] Header has been added to all new source files (run *build/UpdateHeaders.bat*) --> _not applicable_ - [ ] Contains **NO** breaking changes <!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. Please note that breaking changes are likely to be rejected. --> ## Other information
Kyaa-dost
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me 🚀 🚀
## Fixes #3519 <!-- Add the relevant issue number after the "#" mentioned above (for ex: Fixes #1234) which will automatically close the issue once the PR is merged. --> <!-- Add a brief overview here of the feature/bug & fix. --> Removes two restrictions from `ObservableGroup` to make it usable in more situations. In my case, I wanted to be able to rename the groups (for this I needed a mutable key), and I wanted to add properties on the group level (I needed to unseal it) - Removes the immutable restriction on the `Key` property and makes the `Key` property observable. - Removes the `sealed` keyword from `ObservableGroup` ## PR Type What kind of change does this PR introduce? <!-- Please uncomment one or more that apply to this PR. --> <!-- - Bugfix --> - Feature <!-- - Code style update (formatting) --> <!-- - Refactoring (no functional changes, no api changes) --> <!-- - Build or CI related changes --> <!-- - Documentation content changes --> <!-- - Sample app changes --> <!-- - Other... Please describe: --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. --> `ObservableGroup` has an immutable `Key` property `ObservableGroup` is not inheritable ## What is the new behavior? <!-- Describe how was this issue resolved or changed? --> `ObservableGroup` has a mutable `Key` property `ObservableGroup` is inheritable ## PR Checklist Please check if your PR fulfills the following requirements: - [ ] Tested code with current [supported SDKs](../readme.md#supported) - [x] Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: MicrosoftDocs/WindowsCommunityToolkitDocs#394 - [x] Sample in sample app has been added / updated (for bug fixes / features) --> _no update needed_ - [x] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/windows-toolkit/WindowsCommunityToolkit-design-assets) --> _not applicable_ - [x] Tests for the changes have been added (for bug fixes / features) (if applicable) --> _not applicable_ - [x] Header has been added to all new source files (run *build/UpdateHeaders.bat*) --> _not applicable_ - [ ] Contains **NO** breaking changes <!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. Please note that breaking changes are likely to be rejected. --> ## Other information
Docs for Toolkit PR #3526
What changes to the docs does this PR provide?
PR Checklist
Please check if your PR fulfills the following requirements:
masterfor new features,livefor typos/improvements)Other information