neovim icon indicating copy to clipboard operation
neovim copied to clipboard

docs(tutor): add instruction to reload tutor ...

Open goyalyashpal opened this issue 2 years ago • 2 comments

Problem: Any change to line numbers break the line-number based tests from *.tutor.json. This is problematic for lessons involving unbalanced line deletions or insertions. Solution: Instruct to reload the tutor, thus discarding any edits. Fortunately, only "Lesson 2.6: OPERATING ON LINES" involves such line modifications. So, this is needed only there.

Closes: https://github.com/neovim/neovim/issues/28164

goyalyashpal avatar Apr 04 '24 16:04 goyalyashpal

Invalid commit message: "docs(tutor): add instruction to reload tutor ..." Commit: df65fd981ce9d0751faf211835dc6cf0e51e9bfc Description ends with a period ("."). https://github.com/neovim/neovim/actions/runs/8557764439/job/23450794908#step:5:16

so, ellipsis are not used in commits with the optional body? these seemed to help while git log --oneline on CLI etc.

just asking for confirmation before removing these

goyalyashpal avatar Apr 04 '24 16:04 goyalyashpal

so, ellipsis are not used in commits with the optional body?

subject is different than body.

your subject ends with "..." , what is the point of that? just remove the "..."

justinmk avatar Apr 07 '24 23:04 justinmk

your subject ends with "..." , what is the point of that?

using in git cli,

  • where there's no inbuilt hint regarding whether there's any further body to the commit message or not.
  • there, it's only these explicit ellipsis in commit title/subject which hint regarding "there's more here", otherwise all look same
  • what's more, i think that the ... button on GUIs of github etc is inspired from this convention itself

see below:

i picked this style from some git-commit message guide some time ago.

$ git log --oneline -n4 --no-decorate
6ae778857 theia: Add version 1.49.1 ...           <~~~
d48d63f0b q-dir: Update to version 11.64
84c3acc8d peazip: Update to version 9.8.0
57301172f notesnook: Update to version 3.0.4

goyalyashpal avatar May 11 '24 10:05 goyalyashpal

Do you plan to finish this? The details about git are off topic.

justinmk avatar May 11 '24 14:05 justinmk

Do you plan to finish this?

😆 oh lol.

  • i had shared all my investigation and conclusion as far back as 2024.04.04 (more than a month ago).
  • infact, i was awaiting ur response 😅. u asked me to update, which i did. but nobody never answered even then.

just to iterate here again:

  • the only feasible way i could think of to solve this is to reload the tutor,
  • and i didn't get any response on how can that be done!

Verbatim quoting:

hi @ justinmk is it possible to reload/revert the tutor?

  • following this: edit-a-file, i tried doing :e! inside the :Tutor, and it showed me blank. ...
  • i even tried rerunning :Tutor inside :Tutor, but again showed me blank.

do you have any other thoughts?

- me at https://github.com/neovim/neovim/issues/28164#issuecomment-2037384192

goyalyashpal avatar May 11 '24 16:05 goyalyashpal