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

Create package structure outline #18

Open
andrewtavis opened this issue Apr 8, 2021 · 0 comments
Open

Create package structure outline #18

andrewtavis opened this issue Apr 8, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers question Further information is requested

Comments

@andrewtavis
Copy link
Owner

andrewtavis commented Apr 8, 2021

wikirepo as a project has many modules that interconnect and are funneled to two functions - wikirepo.data.query and lctn_utils.gen_lctns_dict. It would be helpful for users and potential contributors to have a visual representation of the package that details the overarching structure and the purpose of various components. This outline could then be added to the readme in the To-Do section, potentially in a drop down.

An initial test of this could be as simple as a directory outline that has a bit more detail about the given components - say by using *, **, †, ‡ and other symbols to indicate where a description could be found.

A discussion of how to best present the package structure is more than welcome, and contributions would further be very appreciated!

@andrewtavis andrewtavis added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers question Further information is requested and removed help wanted Extra attention is needed labels Apr 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant