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(nav-controller): full review of docs #18848

Merged
merged 2 commits into from
Jul 22, 2019

Conversation

rtpHarry
Copy link
Contributor

@rtpHarry rtpHarry commented Jul 21, 2019

Started as a simple typo but ended up reviewing all docs items on the page.

Mostly fixed grammar, and some typos.

One mistake I would like to get an opinion on was that navigateBack was mentioned twice in one docs block. I changed it to navigateRoot but just want to be sure this was the correct change before it ends up in the official docs:

It's recommended to use navigateForward(), navigateBack() and navigateRoot() instead of setDirection().

This is the only change that was "new" content.

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this introduce a breaking change?

  • Yes
  • No

Other information

@ionitron-bot ionitron-bot bot added the package: angular @ionic/angular package label Jul 21, 2019
@rtpHarry rtpHarry changed the title docs(nav-controller): fix typo trigger / triggered docs(nav-controller): full review of docs Jul 21, 2019
@brandyscarney brandyscarney merged commit 854004c into ionic-team:master Jul 22, 2019
@brandyscarney
Copy link
Member

Thank you!

@rtpHarry rtpHarry deleted the patch-5 branch July 22, 2019 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: angular @ionic/angular package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants