Add README for the data and formatter layers. - #40
Conversation
Signed-off-by: RafsanNeloy <rafsanneloy@gmail.com>
README for the data and formatter layers.
|
|
||
| ### The Modules at a Glance (with Example Commands!): | ||
|
|
||
| * **`background_activities.py`**: Tracks backend jobs in progress (`cbrain background`). |
There was a problem hiding this comment.
Do we want to hyperlink of this file or this is okay?
|
Can you please give me suggestion how can I improve this more? |
|
Could you put some more details and refine the focus of this in light of what is in plan.md? |
|
Thanks for adding these READMEs. The overall structure is helpful, but two descriptions should be corrected before merging:
The checks are passing, and otherwise the documentation looks good! |
Signed-off-by: rafsanneloy <rafsanneloy@gmail.com>
Signed-off-by: Rafsanul Islam Neloy <89649374+RafsanNeloy@users.noreply.github.com>
|
@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 😅 |
|
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:
These are minor documentation corrections. Everything else looks good, and all checks are passing. Nice work improving the documentation! |
Added a local
READMEfile for the top level foldersdataandformatterCloses #28