Package: toot
Version: 0.27.0-1
Severity: normal
Tags: upstream
X-Debbugs-Cc: debbug.t...@sideload.33mail.com

When posting from the commandline, if -e is used then a template
states that lines beginning with a hash (“#”) are ignored. This is a
problem because it’s very often useful to begin a line with a
hashtag. It’s in fact common to write just hashtags on the last line
of a message.

It’s unclear¹ why users would want to put comments in a temporary text
file that will be destroyed right after posting, but certainly a hash
symbol should be avoided. Possible alternatives:

  % LaTeX and Erlang comments go from percent symbol to EOL
  /* comments in C, graphviz and many other languages² begin with forward slash 
asterisk and end with */
  // C++ comments go from // to EOL
  -- Ada comments go from -- to EOL
  ; Forgot where I’ve seen this but some app’s comments go from semicolon to EOL
  <!-- HTML comments begin with left angle bang 2 hyphens and end with -->
  [//]: # (markdown comments are complicated)

Considering some simplified subset of HTML is specified for
activitypub posts, HTML comments may be the most suitable.

Possible other bugs:

I’ve only identified this bug in the CLI version specifically in
conjunction with using an editor. I have not tested what happens to
lines beginning with hash when the text body is supplied on the
commandline, or what happens in the TUI. If the pure non-interactive
CLI approach is affected, then it would be a bug that the man page
does not cover it.

footnotes:

① implementation of https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1038664 
would make comments more useful
② https://web.archive.org/web/20230301231734/geekflare.com/how-to-add-comments/

Reply via email to