Skip to content

Readability improvement and format changes #2810

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.

Sign up for GitHub

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

Jump to bottom
Closed
nidheekamble wants to merge 6 commits into from
Closed

Readability improvement and format changes #2810

nidheekamble wants to merge 6 commits into from

Conversation

@nidheekamble
Copy link

@nidheekamble nidheekamble commented Sep 19, 2019

References

PR Checklist

  • CLA signed. If not, go over here and sign the CLA
  • Tests added/passed
  • Requires documentation to be updated
  • I'm ready to accept this work might be rejected in favor of a different grand plan.

zadjii-msft
zadjii-msft requested changes Sep 19, 2019
View reviewed changes
Copy link
Member

@zadjii-msft zadjii-msft left a comment

Choose a reason for hiding this comment

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

I'm blocking only on the "OS" thing, because that's actually important

doc/AddASetting.md Outdated
`.../console/published/wincon.w` in the OS repo when you submit the PR.
### 1. Add to wincon.w
* THIS IS NOT IN OPENCONSOLE. Make sure you update
`.../console/published/wincon.w` in the Open Source repository when you submit the Pull Request.
Copy link
Member

@zadjii-msft zadjii-msft Sep 19, 2019

Choose a reason for hiding this comment

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

Actually, this is supposed to be "OS". I'm referring to the actual Windows OS repo here, this isn't a change that can be made entirely in the open-source repo here.

Copy link
Author

@nidheekamble nidheekamble Sep 19, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Oh, my mistake. I'll remember that.
I changed it; is that fine now or should it just be 'OS' (without 'repo')?

doc/AddASetting.md Outdated
- `propsheet/registry.cpp@GetRegistryValues` should make sure to read the property from the registry

4. Add the field to the propslib registry map
### 4. Add the field to the propslib registry map
Copy link
Member

@zadjii-msft zadjii-msft Sep 19, 2019

Choose a reason for hiding this comment

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

Making these into h3's without any sub-points feels stylistically weird to me - @bitcrazed / @cinnamon-msft want to weigh in on this?

Copy link
Author

@nidheekamble nidheekamble Sep 19, 2019

Choose a reason for hiding this comment

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

@zadjii-msft I agree Mike; I did find it to be 'stylistically weird' as well, but then I thought it would be breaking the uniformity otherwise.

Copy link
Contributor

@cinnamon-msft cinnamon-msft Sep 19, 2019

Choose a reason for hiding this comment

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

I feel making them bold would be better than h3's

doc/AddASetting.md
- `Wtypes.PROPERTYKEY PKEY_Console_`
- `NT_CONSOLE_PROPS`
### 7. Update the feature test properties to get add the setting as well
`ft_uia/Common/NativeMethods.cs@WinConP`:
Copy link
Member

@zadjii-msft zadjii-msft Sep 19, 2019

Choose a reason for hiding this comment

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

This particular sub point seems weird now, it feels like it lost the connection to the parent bullet point (which is now the header)

Copy link
Author

@nidheekamble nidheekamble Sep 19, 2019

Choose a reason for hiding this comment

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

What do you suggest should be done?

@ghost ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Sep 19, 2019
@nidheekamble @zadjii-msft
Point 3 made more precise
ca906a9 
Co-Authored-By: Mike Griese <migrie@microsoft.com>
@ghost ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Sep 19, 2019
nidheekamble and others added 2 commits September 19, 2019 18:20
@nidheekamble @zadjii-msft
Minor change in linebreak
ec9b1bc 
Co-Authored-By: Mike Griese <migrie@microsoft.com>
@nidheekamble
'OS' clarification
a17e6b6
@DHowett-MSFT DHowett-MSFT added the Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs label Oct 15, 2019
zadjii-msft
zadjii-msft reviewed Nov 25, 2019
View reviewed changes
Copy link
Member

@zadjii-msft zadjii-msft left a comment

Choose a reason for hiding this comment

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

Sorry for delays in reviewing. I think it's mostly fine, I just have a minor nit around the formatting in bullet point 7.

doc/AddASetting.md Outdated
**7. Update the feature test properties to get add the setting as well**
`ft_uia/Common/NativeMethods.cs@WinConP`:
- `Wtypes.PROPERTYKEY PKEY_Console_`
- `NT_CONSOLE_PROPS`
Copy link
Member

@zadjii-msft zadjii-msft Nov 25, 2019

Choose a reason for hiding this comment

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

I think this needs to maybe all be indented another layer, like the src/propsheet/registry.cpp entries in bullet 3. Otherwise it runs into the title in the rendered markdown

Copy link
Author

@nidheekamble nidheekamble Dec 1, 2019

Choose a reason for hiding this comment

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

No problem with the delay, Mike.
I changed it now. Comments?

zadjii-msft
zadjii-msft requested changes Dec 2, 2019
View reviewed changes
doc/AddASetting.md
**7. Update the feature test properties to get add the setting as well**
`ft_uia/Common/NativeMethods.cs@WinConP`:
- `Wtypes.PROPERTYKEY PKEY_Console_`
- `NT_CONSOLE_PROPS`
Copy link
Member

@zadjii-msft zadjii-msft Dec 2, 2019

Choose a reason for hiding this comment

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

Suggested change
- `NT_CONSOLE_PROPS`
- `NT_CONSOLE_PROPS`

(same here)

doc/AddASetting.md

**7. Update the feature test properties to get add the setting as well**
`ft_uia/Common/NativeMethods.cs@WinConP`:
- `Wtypes.PROPERTYKEY PKEY_Console_`
Copy link
Member

@zadjii-msft zadjii-msft Dec 2, 2019

Choose a reason for hiding this comment

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

Suggested change
- `Wtypes.PROPERTYKEY PKEY_Console_`
- `Wtypes.PROPERTYKEY PKEY_Console_`

We should probably keep the indentation of these sub-points consistent with other indentation in this file

doc/AddASetting.md
Now, your new setting should be stored, just like all the other properties.

**7. Update the feature test properties to get add the setting as well**
`ft_uia/Common/NativeMethods.cs@WinConP`:
Copy link
Member

@zadjii-msft zadjii-msft Dec 2, 2019

Choose a reason for hiding this comment

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

Suggested change
`ft_uia/Common/NativeMethods.cs@WinConP`:
- `ft_uia/Common/NativeMethods.cs@WinConP`:

Without the hyphen here, markdown will just concatenate this line with the previous line

@ghost ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 2, 2019
@ghost ghost added the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Dec 9, 2019
@ghost
Copy link

ghost commented Dec 9, 2019

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

@ghost ghost closed this Dec 16, 2019
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zadjii-msft zadjii-msft zadjii-msft requested changes

@cinnamon-msft cinnamon-msft Awaiting requested review from cinnamon-msft

Assignees

No one assigned

Labels

Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@nidheekamble @zadjii-msft @cinnamon-msft @DHowett-MSFT