Puncte:0

Ajutor pentru opțiunile funcției

drapel jp

Scriu documentație pentru o funcție bash pe care o scriu. Acceptă o opțiune de culoare care poate fi una dintre ele --vlt --blu --grn --ylw --orn --pur --red --wht. Am folosit următoarea descriere, dar nu sunt sigur dacă ar fi suficient de înțeles și aș dori îmbunătățiri acest ajutor descriptiv.

 --COLR
   Opțiune de culoare
 
   --COLR Brief | --COLR Brief
   ----------------+-----------------
   --vlt Violet | --orn Orange
   --blu Albastru | --purpuriu
   --grn Verde | --roșu Roșu
   --ylw Galben | --alb
Artur Meinild avatar
drapel vn
Cred că acest lucru s-ar baza în mare măsură pe opinia individuală și, prin urmare, în afara subiectului aici. Vă sugerez să faceți un sondaj cu utilizatorii cu cei care ar trebui să citească documentația și să-și obțină părerea. Noroc!
drapel jp
Există programe de linie de comandă care fac acest tip de listă de tabel de opțiuni?
terdon avatar
drapel cn
Sunt sigur că va exista. Fiecare autor de program este liber să facă ce vrea în opțiunile sale. Dar, deoarece aceasta nu este cu adevărat o întrebare despre Ubuntu, sunt de acord cu Artur că nu este în afara subiectului. Personal, aș avea doar o opțiune `--color` care preia valori (de exemplu, `--color blue`) și apoi aș oferi o listă de valori acceptabile în mesajul de ajutor.
Puncte:0
drapel sa

Documentația funcției bash ar fi mai ușor de înțeles dacă ați înlocui cuvântul ambiguu „Scurt” cu expresia mai descriptivă „Nume culoare”. Dacă este un manual care este invocat de la terminal de către om de asemenea, puteți îmbunătăți lizibilitatea prin formatarea primului rând ca text aldine, așa cum se face frecvent în paginile manuale.

--COLR
  Opțiune de culoare

  --COLR Nume culoare | --COLR Nume culoare
  --------------------+---------------------
  --vlt Violet | --orn Orange
  --blu Albastru | --purpuriu
  --grn Verde | --roșu Roșu
  --ylw Galben | --alb     

Postează un răspuns

Majoritatea oamenilor nu înțeleg că a pune multe întrebări deblochează învățarea și îmbunătățește legătura interpersonală. În studiile lui Alison, de exemplu, deși oamenii își puteau aminti cu exactitate câte întrebări au fost puse în conversațiile lor, ei nu au intuit legătura dintre întrebări și apreciere. În patru studii, în care participanții au fost implicați în conversații ei înșiși sau au citit transcrieri ale conversațiilor altora, oamenii au avut tendința să nu realizeze că întrebarea ar influența – sau ar fi influențat – nivelul de prietenie dintre conversatori.