As Roblox developer, it is currently frustrating to use the new Docs site to look up documentation for libraries because they are poorly formatted, making it hard to read quickly.
This is how the documentation for, as an example, string.byte
looks at the moment:
As a programmer, the signature of the function and the argument types/explanations are important for me to be able to read at a glance. There is currently far too much whitespace for that to be practical, and the type signature isn’t immediately obvious.
My goal as a programmer is to spend as little time looking at documentation as possible, and the current formatting doesn’t further this goal. I would prefer a more compressed description of library members and a type signature (similar to JavaScript’s or Rust’s documentations).
If Roblox were to compress the documentation for functions and include a signature with them, it would make my life better by reducing the amount of time I had to spend looking at documentation and increase the time I spent working on projects.