‹ WatchnoteCode comments
A comment on a line of its own that starts with owner/repo#123: and a note watches that issue or PR for as long as the comment is on your repo's default branch. It's the only way to watch something: the note is shown on the item and at the top of its emails, with a link to the line. Delete the comment and the item is no longer watched.
Watchnote scans the repos your GitHub tokens in Settings can read and you can push to, forks aside, again whenever they're pushed to. Files over 1 MB and binary files are skipped.
Works
// owner/repo#123: whyC, C++, C#, Go, Java, JavaScript, TypeScript, Rust, Swift, Kotlin
# owner/repo#123: whyPython, Ruby, shell, YAML, TOML, Dockerfile, Makefile
-- owner/repo#123: whySQL, Lua, Haskell
;; owner/repo#123: whyLisp, Clojure, INI, assembly
% owner/repo#123: whyTeX, Erlang, MATLAB
' owner/repo#123: whyVisual Basic
/* owner/repo#123: why */Block comments, on one line
* owner/repo#123: whyA line inside a block comment
/// owner/repo#123: whyDoc comments, like Rust's /// and //!
<!-- owner/repo#123: why -->HTML, XML, Markdown
(* owner/repo#123: why *)OCaml, Pascal
{- owner/repo#123: why -}Haskell block comments
""" owner/repo#123: why """Python docstrings, on one line
owner/repo#123: whyA line with no comment marker, like inside a docstring or a Markdown file
+ // owner/repo#123: whyA line added by a .patch or .diff file
Any comment marker made of punctuation or symbols works, not only these. Only the closers shown above, like */ and -->, are trimmed from the end of the note.
Doesn't work
x := f() // owner/repo#123: whyAfter code on the same line
// see owner/repo#123: whyAfter other words
// github.com/owner/repo/issues/123: whyAs a link
// owner/repo#123With no note
// owner/repo#123:whyWith no space after the colon
- // owner/repo#123: whyOn a line a patch file removes
Put the reference first on the line, followed by a colon, a space and why the code depends on it. One reference per line.