documentation issues

[hydrargyrum]

documentation issues

[merriam]

You might get faster answers in the discord.

Keys are listed in keys.py, which is both all the listed keys and their textual representation.

I'm unclear on the third part of your question. Are you asking about how the BINDINGS variable is processed?

[merriam]

Sorry, my comment looks terse in retrospect. No emoji anywhere~ 😸

You are suggesting a line n the Guide/Input Bindings section could point to keys.py? Also, removing the paragraph mentioning the Binding Class as the class does not provide more options?

[hydrargyrum]

Keys are listed in keys.py, which is both all the listed keys and their textual representation.

Of course, but I think a library's documentation's role is to avoid having to read the library's source code!

You are suggesting a line n the Guide/Input Bindings section could point to keys.py?

Not merely point to keys.py, include all the enum keys in the documentation, see for example https://doc.qt.io/qt-6/qt.html#Key-enum

for classes, the module to import them from is not indicated, for example, on https://textual.textualize.io/api/binding/ textual.binding.Binding is not mentioned anywhere

The problem is similar, of course I could grep Binding in textual's source code, and see in what file it's present, then import from that file. But I think the documentation could also simply mention that information so the documentation is enough in itself.

There are some projects where there's very little documentation, and by reading it, it's obvious you'll very soon have to read not only the docs but also the source code. By contrast, textual's docs cover many topics, from different point of views (e.g. tutorial, guide, reference, API), it's pretty good, but then its quality makes expect that I don't have to read the source code! ;)

I'm unclear on the third part of your question. Are you asking about how the BINDINGS variable is processed?

Not exactly, for BINDINGS/Binding(), one can use Keys.Left constant, but it's also possible to use "left" string. This should be explicit, and a bit more exhaustive:

• list all Keys enum entries (since the list is finite)
• describe how the string to pass is built, for example Ctrl+A should be passed as the string "ctrl-a" which is not obvious without documentation telling it

[darrenburns]

I agree that modules listed in the reference should include the path of the module.

The title of the API reference for textual.binding is Binding, which confusingly is also the name of a class inside textual.binding.

I think the title of API reference pages for modules should just be the module path, so textual.binding - anything else is pretty confusing.