pyformat.info icon indicating copy to clipboard operation
pyformat.info copied to clipboard

Make a Dash cheat sheet

Open kissgyorgy opened this issue 10 years ago • 5 comments

Great resource! I would like to see a Dashdoc cheat sheet from this: https://github.com/Kapeli/cheatset#readme

kissgyorgy avatar Apr 24 '15 21:04 kissgyorgy

Interesting, hadn't heard of this Dash feature before :-) Have you created such a cheatsheet before? Right now I'd say that our descriptions, old- and new-style formats as well as the output should probably all simply be put into notes, right?

zerok avatar Apr 25 '15 18:04 zerok

@kissgyorgy am I right to assume that that cheat sheet would have to be hosted in https://github.com/Kapeli/cheatsheets ? If so, that would complicate matters a bit but we couldn't give it a try anyway.

zerok avatar Apr 29 '15 18:04 zerok

Dash is a documentation viewer which allows cheat sheets like this. Making one is just a matter of writing the examples in it's DSL. Yes it would be hosted on that repository where anyone could download it. Here is and example: similar cheat sheet

kissgyorgy avatar Apr 29 '15 19:04 kissgyorgy

I know what Dash is but hadn't heard of that cheat sheet feature before :-)

The one problem I see right now is that we would have to update that cheat sheet in a foreign repo whenever one of the examples changes in ours. I'm not yet sure how we could solve this. It was be awesome if Dash supported additional repos instead of just its own for people to link to, but we could absolutely extend the current script to also generate these cheat sheets.

zerok avatar Apr 30 '15 06:04 zerok

Does GitHub support submodules?

madphysicist avatar Jan 06 '22 23:01 madphysicist