Skip to content

Add README for the data and formatter layers. - #40

Open
RafsanNeloy wants to merge 6 commits into
aces:mainfrom
RafsanNeloy:readme
Open

Add README for the data and formatter layers.#40
RafsanNeloy wants to merge 6 commits into
aces:mainfrom
RafsanNeloy:readme

Conversation

@RafsanNeloy

Copy link
Copy Markdown
Contributor

Added a local README file for the top level folders data and formatter
Closes #28

Signed-off-by: RafsanNeloy <rafsanneloy@gmail.com>
@RafsanNeloy RafsanNeloy changed the title Add README dfor the data and formatter layers. Add README for the data and formatter layers. Mar 13, 2026
Comment thread cbrain_cli/data/README.md

### The Modules at a Glance (with Example Commands!):

* **`background_activities.py`**: Tracks backend jobs in progress (`cbrain background`).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do we want to hyperlink of this file or this is okay?

@RafsanNeloy

Copy link
Copy Markdown
Contributor Author

Can you please give me suggestion how can I improve this more?

@dlq

dlq commented May 15, 2026

Copy link
Copy Markdown
Contributor

Could you put some more details and refine the focus of this in light of what is in plan.md?

@dlq

dlq commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Thanks for adding these READMEs. The overall structure is helpful, but two descriptions should be corrected before merging:

  1. The data/ directory is not strictly for fetching raw objects. It also performs state-changing operations such as uploads, deletes, moves, tag updates, and project switching. Please describe it more broadly as the API interaction layer.
  2. The example output for cbrain file list does not match the current implementation. The actual formatter displays ID, Type, and File Name, without size or status. Please replace it with real output or clearly label it as a conceptual example.

The checks are passing, and otherwise the documentation looks good!

RafsanNeloy and others added 3 commits August 8, 2026 02:16
Signed-off-by: rafsanneloy <rafsanneloy@gmail.com>
Signed-off-by: Rafsanul Islam Neloy <89649374+RafsanNeloy@users.noreply.github.com>
@RafsanNeloy

Copy link
Copy Markdown
Contributor Author

@dlq I have updated the PR with revised README. Kindly review it when you have a chance and let me know if any improvements or changes are needed. Happy to work 😅

@dlq

dlq commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Thanks for making the earlier updates. The revised READMEs are much clearer, and the data-layer description and formatter example now match the implementation well.

I noticed two small wording points before approval:

  1. formatter/README.md says every command supports --json, but commands such as login and logout still produce plain-text output. Could you limit that statement to commands that support structured output?
  2. tests/README.md says every test mocks the HTTP layer. More precisely, network interactions are mocked where applicable, while many tests do not use HTTP at all.

These are minor documentation corrections. Everything else looks good, and all checks are passing. Nice work improving the documentation!

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

Successfully merging this pull request may close these issues.

Required Corrections and Improvements for CBRAIN CLI Project Completion

2 participants