abra.sh docstrings #515

New Issue

moritz · 2023-10-18T10:17:25Z

moritz commented

2023-10-18 10:17:25 +00:00

Following up on #484
The functions in abra.sh should have docstrings that contain some useful information:

A little usage description, what the function is doing and how to use it, that will be printed with abra app cmd ls
A default container that is used if no container is provided in abra app cmd
So many times I have to lookup the compose file to find out in which container I should run the command
A public/private flag, that can be used to hide internal functions from abra app cmd ls
maybe a function naming convention like _myprivatefunction could be used

Following up on https://git.coopcloud.tech/coop-cloud/organising/issues/484 The functions in `abra.sh` should have docstrings that contain some useful information: 1. A little usage description, what the function is doing and how to use it, that will be printed with `abra app cmd ls` 2. A default container that is used if no container is provided in `abra app cmd` So many times I have to lookup the compose file to find out in which container I should run the command 3. A public/private flag, that can be used to hide internal functions from `abra app cmd ls` maybe a function naming convention like `_myprivatefunction` could be used

🎉 1

moritz added the

enhancement

label 2023-10-18 10:17:25 +00:00

decentral1se added the

abra

label 2023-10-18 15:54:46 +00:00

Sign in to join this conversation.

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: coop-cloud/organising#515

abra.sh docstrings #515

`abra.sh` docstrings #515