search

airbnb / DeepLinkDispatch

A simple, annotation-based library for making deep link handling better on Android
http://nerds.airbnb.com/deeplinkdispatch/
4.37k stars 407 forks source link

Better generated documentation format #236

Closed alexfu closed 4 years ago

alexfu commented 5 years ago

The generated documentation (deeplink.txt) is far from readable. Is it markdown? Any markdown parser I've used, spits out the same ugly text with actual newline characters (\n) instead of a new line.

Here is an example output after giving it to a markdown parser:

screen shot 2018-12-20 at 10 25 56 am

The output is .txt so, is it plain text? I don't understand the |#| parts either. The documentation generator is very valuable but the output of the file negates all that.

Hank-Leafly commented 5 years ago

Seconded. The generated doc is virtually unreadable.

felipecsl commented 5 years ago

I agree. This should be addressed by #213 though

rossbacher commented 4 years ago

Closing after #246 is merged.