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

docs(SystemInformation): add list of possible DeviceFamily #1824

Merged
merged 2 commits into from Feb 19, 2018
Merged

docs(SystemInformation): add list of possible DeviceFamily #1824

merged 2 commits into from Feb 19, 2018

Conversation

Odonno
Copy link
Contributor

@Odonno Odonno commented Feb 17, 2018

Issue: #1789

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build or CI related changes
[x] Documentation content changes
[ ] Sample app changes
[ ] Other... Please describe:

What is the current behavior?

Show basic Intellisense info on SystemInformation.DeviceFamily property.

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tested code with current supported SDKs
  • Docs have been added/updated which fit documentation template. (for bug fixes / features)
  • Sample in sample app has been added / updated (for bug fixes / features)
  • Tests for the changes have been added (for bug fixes / features) (if applicable)

What is the new behavior?

Add list of possible values of SystemInformation.DeviceFamily property in XML docs so devs can see them when using the property.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@XamlBrewer Not sure what to do about the link to Microsoft docs.

@XamlBrewer
Copy link
Contributor

I would start the comments with "Common values include:" and end with "Prepare your code for other values."

@XamlBrewer XamlBrewer closed this Feb 18, 2018
@XamlBrewer XamlBrewer reopened this Feb 18, 2018
Copy link
Contributor

@XamlBrewer XamlBrewer left a comment

Choose a reason for hiding this comment

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

I would start the comments with "Common values include:" and end with "Prepare your code for other values."

It has to be clear that the list is not complete.

/// <term>"Windows.Xbox"</term>
/// </item>
/// <item>
/// <term>"Windows.Holographic"</term>
Copy link
Member

Choose a reason for hiding this comment

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

Should we add more after each point like common devices that use these types? i.e. HoloLens and Mixed Reality devices for holographic and Surface Hub for Team.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. We can add more information on the <description> node. The best option would be to add it on each item value but we need to be sure what to add on it. Like for Windows.Desktop, I suppose it englobes desktops, laptops and tablets.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can add it in a future PR if it is necessary.

@nmetulev nmetulev merged commit ada7903 into CommunityToolkit:master Feb 19, 2018
@windowstoolkitbot
Copy link

This PR is linked to unclosed issues. Please check if one of these issues should be closed: #1789

@Odonno Odonno deleted the deviceFamilyInfo branch February 19, 2018 22:15
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

5 participants