Treat __init__.py (or docstring form __init__.py) as README file if README file does not exist
Proposal
Currently, GitLab shows the content of README file in the web interface of a directory. That is a great and very useful feature! In the case of developing the python packages, the common practice is writing the documentation for the packages and sub-packages in docstrings of __init__.py
. I hereby propose the GitLab developers to consider showing the content of __init__.py
, or, if possible, the content of its docsting, as a README, if README file is not present in the folder.
The same approach can be adopted with other programming languages, but nothing comes into my mind now.
Edited by Grigorii Smirnov-Pinchukov