microsoft / codetour

VS Code extension that allows you to record and play back guided tours of codebases, directly within the editor.
https://aka.ms/codetour
MIT License
4.36k stars 113 forks source link

README.md: confusing mention of "rebase" #261

Open peter-lyons-kehl opened 2 years ago

peter-lyons-kehl commented 2 years ago

README.md & Marketplace reads: edit the tour's ref by right-clicking it in the CodeTour tree and selecting Change Git Ref. This let's you "rebase" a tour to a tag/commit...

However:

  1. Have a tour with GIT commit reference
  2. Modify the source code above (before) a tour step (tour step having line)
  3. Commit (the source code change) to GIT.
  4. Change the tour's GIT reference to the new commit.

Mainstream understanding/use of term rebase implies that the above steps would update the tour step to have a line number from the new GIT commit. (I'd assume there could be an API to get the line shifts (per file) between two GIT commits for some changes, depending on how GIT generates the deltas.)

Please

Thank you in advance.