search

timothycrosley / pdocs

A simple program and library to auto generate API documentation for Python modules.
Other
76 stars 20 forks source link

Double spacing while displaying the source code in the generated web pages? #39

Open dragondive opened 1 year ago

dragondive commented 1 year ago

Hello @timothycrosley,

First of all, thank you very much for your other project portray. I must express my appreciation especially for how easy it is to use. I have never experienced such great UX in any of the other tools I have used (and not just in the area of python document generation).

Now, coming to the current question. I noticed that the View Source there uses double spacing in the source code.

I figured out by reading the source that it comes from the \n in the following line of this (pdocs) project (and similar lines in a couple of places elsewhere in the file). I verified this by forking and testing locally.

https://github.com/timothycrosley/pdocs/blob/3d0fceee528db8fb4d107c401f5b42e3ec9d4bbf/pdocs/templates/text.mako#L85

Is the double spacing done to make the source code "easy on the eyes" in the web browser? Would it be okay to provide an option to disable the double spacing?

Note: I only want to understand the reason why it was done in this way, and I'm not "complaining" about it. :smile: I intend to introduce portray to my colleagues and friends. I want to be prepared with an answer to a question I can already anticipate. :)