Typos

[danielbanda]

Closes #85

Fixed some documentation typos 😉

PR Checklist

• Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
• Based off latest main branch of toolkit
• PR doesn't include merge commits (always rebase on top of our main, if needed)
• Tested code with current supported SDKs
• New component
  • Pull Request has been submitted to the documentation repository instructions. Link:
  • Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
• Tests for the changes have been added (for bug fixes / features) (if applicable)
• Header has been added to all new source files (run build/UpdateHeaders.bat)
• Contains NO breaking changes
• Every new API (including internal ones) has full XML docs
• Code follows all style conventions

[net-foundation-cla]

All CLA requirements met.

[Sergio0694]

Looks great! Couple of small nits:

• Is the linked issue wrong? That seems unrelated to the changes here 🤔
• Could you rebase and drop the top two commits (the accidental one and the one just reverting it?). I'd rather just have a single clean commit in the PR.

Thank you! 😄

[Nirmal4G]

@Sergio0694 You could squash merge to get a single clean commit too!?

[Sergio0694]

@Nirmal4G We're trying to just merge PRs normally, as that preserves the history better. Squashing still preserves the individual commits, which in this case are just not meaningful. I'd rather just have PRs only keep the commits they need. This is also why eg. when doing lots of trial and errors, I'd rather just squash those commits and force push to the PR branch, and then merge that PR normally (so that all commits are kept but you still don't have a dozen test commits that are just clutter).

I'll keep this open for a few days in case Daniel gets back, if not I'll close and cherry-pick this commit manually 🙂

[Nirmal4G]

@Sergio0694 What you described is rebase merge. Squashing takes all the changes from the tip and combines into a single commit on top.

...preserves history better...

All merge strategies provided by github PR flow preserve history except rebase merge (This behavior can be changed) but only the way they merge is different. You can configure merge options in repo settings.

Squash and Merge your PR commits

Personally, I prefer linear history on master branch but that's just me! 😇 But for some PRs under community toolkit, especially mine (I always specify what merge strategy should be used) and some others I've noticed, sometimes squashing or rebasing works best. Merge commit doesn't always preserve history properly.

For instance, Blame gets messed up if you include lines that have cascading changes, diff into completely different than viewing individual commits. For this reason, I always recommend against merge commit. Use merge commit only when you want a branch with an explicit patch tree (that doesn't contain cascading changes on the same lines) else do a squash merge or rebase merge.

[Sergio0694]

@danielbanda leaving instructions here for what to do since I can see it might not have been clear.
If what I asked wasn't clear though, just feel free to ask next time 🙂

"Could you rebase and drop the top two commits (the accidental one and the one just reverting it?). I'd rather just have a single clean commit in the PR."

What you need to do is the following:

• git rebase -i HEAD~3
• Change the top 2 commits (the accidental one and the revert) to drop
• Save and exit. If vim opened for the rebase and you're not familiar with it, do this:
  • Press "i" to enter "insert" mode. Move to the top two commit and change them to "drop".
  • Press ESC, then type ":wq" and ENTER to save and exit.
• git push --force origin <YOUR_BRANCH_NAME> to force push

After this, the PR will just have the first commit nice and clean, with nothing else 👍

[danielbanda]

HI @Sergio0694, thanks to your thorough instructions I was able to rebase the PR to a single commit.

[Sergio0694]

LGTM!

Thank you for taking the time to properly rebase this! 😄

[Nirmal4G]

@danielbanda The fixes issue mentioned might be wrong, since it closed my PR!