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

Update docs/FAQ.md #1640

Merged
merged 2 commits into from
Aug 7, 2016
Merged

Update docs/FAQ.md #1640

merged 2 commits into from
Aug 7, 2016

Conversation

alexandair
Copy link
Contributor

@alexandair alexandair commented Aug 4, 2016

  • Resolves issue #abcd.
  • Code is rebased on origin/master.
  • N/A Add tests that fail without your changes.
  • Update all relevant documentation.

Fixing typos and formatting.

Fixing typos and formatting.
@alexandair
Copy link
Contributor Author

@raghushantha Please, review.

@TravisEz13 TravisEz13 added the Area-Maintainers-Documentation specific to documentation in this repo label Aug 6, 2016
@TravisEz13
Copy link
Member

I restarted the tests. I don't see how it's an issue with the PR unless you need to rebase.

@alexandair
Copy link
Contributor Author

I don't know what causes a problem. This PR doesn't have conflicts and it's created online using the latest version of the article.

@TravisEz13
Copy link
Member

@alexandair, They all passed on rerun. It must have been an environmental issue like I thought.

@alexandair
Copy link
Contributor Author

Great. Please, merge if changes are OK.

more information.
Error handling in PowerShell is a bit weird, as not all errors result in catchable exceptions by default.
Setting `$ErrorActionPreference = 'Stop'` will likely do what you want;
that is, cause non-terminating errors to instead terminate.
Copy link
Member

@TravisEz13 TravisEz13 Aug 6, 2016

Choose a reason for hiding this comment

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

to instead terminate -> instead to terminate
The to-infinitive to terminate has been split by the modifier instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think you mean: "that is, it will cause non-terminating errors to terminate."

If you feel strongly about "instead" you should probably put it at the end. Something like: "Setting $ErrorActionPreference = 'Stop' will likely do what you want; that is, cause normally non-terminating errors to terminate instead."

@TravisEz13
Copy link
Member

Please update the PR template with the issue this resolves.

@alexandair
Copy link
Contributor Author

I'm not aware of the issue we will resolve with this PR.

@TravisEz13
Copy link
Member

Please be sure to open an issue for all PRs in the future and refer to it in the pull request template. This is required per our contribution guidelines.

@TravisEz13 TravisEz13 merged commit e945c62 into PowerShell:master Aug 7, 2016
@TravisEz13 TravisEz13 added this to the 6.0.0-Alpha.10 milestone Aug 7, 2016
@TravisEz13 TravisEz13 assigned TravisEz13 and unassigned raghushantha Aug 7, 2016
@alexandair alexandair deleted the patch-2 branch August 7, 2016 16:53
@alexandair
Copy link
Contributor Author

@TravisEz13 I don't follow you. I don't see anyone creating issues for PRs related to documentation. I couldn't find that in Contribution guidelines. Guidelines are different for PRs to docs and code.

@TravisEz13
Copy link
Member

Per Contributing to docs

Contributing to documentation related to contributing or maintaining the PowerShell Project
When writing Markdown documentation, use semantic linefeeds. In most cases, it means "once clause / idea per line".
Otherwise, these issues should be treated like any other issue in this repo.

download PowerShell (which it then uses to build and test through the
`build.psm1` module). However, the following caveat applies:
download PowerShell (which it then uses to build and test through the `build.psm1` module).
However, the following caveat applies:

> Encrypted variables are not added to untrusted builds such as pull requests
> coming from another repository.

Thus a pull request made from a fork of the PowerShell repository will not pass
Copy link
Member

Choose a reason for hiding this comment

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

This is no longer true either.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@andschwa Could you open a PR to fix that?

@alexandair
Copy link
Contributor Author

@TravisEz13 I don't think that sentence states that we should first open an issue, and than open a PR to fix the issue as you are implying. If that's true then it should be stated clearly. As I've said earlier, I don't see anyone doing that.

@TravisEz13
Copy link
Member

@alexandair We have recently changed the contribution guidelines and maintainers and starting reviewing for compliance with governance. First, I pointed to the area that said that you must follow the PR template, and you said that did not apply because this was a doc change. So, I pointed you to the guidance that said the rules of code PR's apply to doc PRs in this repo. Which includes this guidance ` Therefore, you should fill out the PR template and supply an issue (create one if it doesn't exist.)
I have updated the current governance PR with your comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Maintainers-Documentation specific to documentation in this repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants