NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
462 stars 105 forks source link

google doc string with tab length ==4 not 2 #182

Open aaa34169 opened 3 years ago

aaa34169 commented 3 years ago

First. thank for your package. I am using it for documenting mine.

i use google doctring and would like to add an example section.

I simply wrote in my editror ( atom , with tab length set to 4)

Examples:

    analysisInstance = analysis.makeAnalysis(DATA_PATH,
                            [file1.c3d,"file2.c3d"],

the ouput markdown ouput a code with 2 spaces instead of 4 preventing to display litteral code.

is there a setting to alter somewhere

regards

Fabien

NiklasRosenstein commented 3 years ago

Thanks for reporting this @aaa34169 . It will need to be fixed in the GoogleProcessor class here in case you want to attempt a fix:

https://github.com/NiklasRosenstein/pydoc-markdown/blob/d74efe746fbd4334e63f00eba5d9c571a998576f/pydoc-markdown/src/pydoc_markdown/contrib/processors/google.py#L140-L149