Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Experimental Feature Request] Story driven programming #258

Closed
sansyrox opened this issue Aug 2, 2022 · 1 comment
Closed

[Experimental Feature Request] Story driven programming #258

sansyrox opened this issue Aug 2, 2022 · 1 comment

Comments

@sansyrox
Copy link
Member

sansyrox commented Aug 2, 2022

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
Copy link
Member Author

Doesn't provide much value. I tried this but this all looked good conceptually but very practical while implementing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant