Document the `# *` syntax

astoff / code-cells.el

Emacs utilities for code split into cells, including Jupyter notebooks

GNU General Public License v3.0

180 stars 11 forks source link

Document the `# *` syntax #4

Closed memeplex closed 2 years ago

memeplex commented 2 years ago

The syntax

#* Optional title
#** Optional title
...

has the problem that it's not PEP8 compatible (missing a space after #), so linters can get very annoying with it.

It seems that you also support:

# * Optional title
# ** Optional title
...

but it's not documented.

astoff commented 2 years ago

Okay, but I just added a subtle suggestion that this is valid in the readme.

astoff commented 2 years ago

I'm getting lots of false positives where people use the asterisk as bullet point and those are considered cell boundaries. So I'm considering changing things so that no space is allowed between the comment syntax and the asterisk. Do you have a strong objection?