Skip to content
This repository has been archived by the owner on Dec 8, 2024. It is now read-only.

docs: added docs for data module and library overview in README #30

Merged
merged 2 commits into from
Aug 20, 2024

Conversation

MitchellJC
Copy link
Collaborator

Added library overview for the tutor looking at our interim codebase submission.

@MitchellJC MitchellJC requested review from leadnaut and LimaoC August 20, 2024 00:37
@MitchellJC MitchellJC self-assigned this Aug 20, 2024
Copy link
Owner

@LimaoC LimaoC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, though my preference would be something like the output from tree so it looks more ~ aesthetic ~

├── client
│   ├── data: ...
│   └── models: ...
├── docs: ...
├── notebooks: ...

@MitchellJC
Copy link
Collaborator Author

MitchellJC commented Aug 20, 2024

lgtm, though my preference would be something like the output from tree so it looks more ~ aesthetic ~

├── client
│   ├── data: ...
│   └── models: ...
├── docs: ...
├── notebooks: ...

Is there a way to call tree and specify the folders and exclude the subfolders?

@LimaoC
Copy link
Owner

LimaoC commented Aug 20, 2024

lgtm, though my preference would be something like the output from tree so it looks more ~ aesthetic ~

├── client
│   ├── data: ...
│   └── models: ...
├── docs: ...
├── notebooks: ...

Is there a way to call tree and specify the folders and exclude the subfolders?

-d gives you just directories, so for me I use something like

$ tree -C -d -L 2
.
├── client
│   ├── data
│   └── models
├── docs
│   ├── build
│   └── source
├── notebooks
├── scripts
├── server
└── tests

@MitchellJC
Copy link
Collaborator Author

lgtm, though my preference would be something like the output from tree so it looks more ~ aesthetic ~

├── client
│   ├── data: ...
│   └── models: ...
├── docs: ...
├── notebooks: ...

Is there a way to call tree and specify the folders and exclude the subfolders?

-d gives you just directories, so for me I use something like

$ tree -C -d -L 2
.
├── client
│   ├── data
│   └── models
├── docs
│   ├── build
│   └── source
├── notebooks
├── scripts
├── server
└── tests

Having trouble doing this with the windows tree. Could you commit this onto the branch for me?

@MitchellJC
Copy link
Collaborator Author

b6c18db ty

@MitchellJC MitchellJC merged commit 5253afa into main Aug 20, 2024
2 checks passed
@MitchellJC MitchellJC deleted the mitch-interim-docs branch August 20, 2024 03:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants