toolshed/organising
7
1
Fork 0
Code Issues 100 Pull Requests Releases Activity

abra.sh docstrings #515

New Issue
Open
opened 2023-10-18 10:17:25 +00:00 by moritz · 0 comments
moritz commented 2023-10-18 10:17:25 +00:00
Member
Copy Link

Following up on coop-cloud/organising#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
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
decentral1se added this to the Abra v0.10.1 project 2025-04-20 05:54:30 +00:00
decentral1se moved this to Backlog in Abra v0.10.1 on 2025-04-20 06:06:40 +00:00
decentral1se moved this to Backlog in Abra v0.10.1 on 2025-04-21 19:08:15 +00:00
decentral1se moved this to Backlog in Abra v0.10.1 on 2025-04-21 19:08:25 +00:00
decentral1se moved this to Backlog in Abra v0.10.1 on 2025-04-24 08:58:35 +00:00
decentral1se moved this to Backlog in Abra v0.10.1 on 2025-04-24 08:58:37 +00:00
decentral1se moved this to Backlog in Abra v0.10.1 on 2025-04-24 08:58:38 +00:00
decentral1se removed this from the Abra v0.10.1 project 2025-04-24 09:01:26 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
abra
Everything to do with abra
abra-gandi
Abra Gandi plugin
awaiting-feedback
Ping/pong on comms
backups
bug
Something is not working
build
Go build related issues
ci/cd
Getting the robots into the mix
community organising
Opening this thing up
contributing
Contributors stuff
coopcloud.tech
Our main website
democracy
Democratic decision making
design
Design thinking required
documentation
Let's write things together
duplicate
This issue or pull request already exists
enhancement
New feature
finance
Money things
funding
Anything related to grant funding
good first issue
Easy start with development
help wanted
Need some help
installer
Installation related issues
kadabra
performance
Performance related
proposal
Large change which requires feedback & decisin making
question
More information is needed
recipes.coopcloud.tech
Our recipes catalogue
security
Securing our shit
test
Unit or integration test suite
wontfix
This won't be fixed
No Label
abra
enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
3wordchant aadil abra-bot ammaratef45 Apfelwurm carla cas coopcloud cyrnel decentral1se fauno iexos jade jmakdah2 joe-irving kawaiipunk knoflook kolaente lambdabundesverband linnealovespie moritz notplants p4u1 pharaohgraphy renovate-bot ripclap simon sixsmith trav val yksflip
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: toolshed/organising#515
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?