Robyn icon indicating copy to clipboard operation
Robyn copied to clipboard

[Experimental Feature Request] Story driven programming

Open sansyrox opened this issue 3 years ago • 0 comments

Current Behavior

Very concise documentation in the codebase.

Desired Behavior

I recently had the idea of writing documentation in the codebase like a story or a narration.

It should be folded by default as I predict that it will be very verbose.

But if we are able to write a documentation that will house things like

  • related files
  • where are helper functions present
  • which files call the modules exported from this current file
  • what are the dependent files/functions
  • where are the tests located

But in a more human readable form. This will allow the a returning programmer or a new programmer to get a much better context than jumping to and from functions and then going through the doc strings.


Screenshots / Mockups

Alternatives


sansyrox avatar Aug 02 '22 13:08 sansyrox