Nová API dokumentace – kritika a návrhy

Abecední řazení je parádní, ale opravdu by si to mohlo pamatovat, podle čeho řadím ;-) + by to mohlo ještě někde napsat…pokud to někde vypisuje, tak jsem slepejš.

A ten hover efekt…mno mohl by být aktivován třeba až po 2 sekundách? Takhle to trošku mlátí do očí ;-)

Jinak je to moc pěkné.

Nebo na kliknutí, to už je na rozvaze…hlavně by se to nemělo zobrazovat okamžitě…

Ještě možná jedna chybka…např. https://api.nette.org/…dentity.html

Blok Method summary má šedivý border kolem dokola a bloky Methods Inherited NEmají šedivý border – left, top, right – kolem nadpisu bloku…

Možná je to feature…možná ne…:-)

Teď jsem to ještě jednou procházel a rozbalení metody „na klik“ bude rozhodně nejlepší…:-)

A ještě jedna věc…pokud metoda vrací pole objektů, je anotována jako @return array of SomeObject. To je super, ale to, že vrací pole objektů je vidět až po najetí myší…ve výpisu metod v levém sloupci je jen public array…imho by tam rovnou mohlo být public array of SomeObject. Co myslíte? Jako příklad: https://api.nette.org/…oLoader.html a metoda getLoaders().

Editoval Ondřej Brejla (7. 10. 2010 11:58)

Hover efekt jsem zpozdil a přidal kotvy na metody, proměnné a konstanty.

Sbalení je nastaveno na klávesu F5.

Pokud zaskroluju, zobrazím metodu a stisknu F5 pro schování, hodí mě to na začátek dokumentu…to je poměrně otravné pokud jsem uprostřed dlouhé třídy ;-)

No fuj, co jsem to sem napsal…aby mě to neházelo na začátek když reloaduju stránku…

Editoval Ondřej Brejla (7. 10. 2010 14:39)

Honza Marek napsal(a):

David Grudl napsal(a):

Sbalení je nastaveno na klávesu F5.

Ty nepoužíváš F5 na reload stránky?

Ehm, nestojíš si na vedení? ;)

to že to nezajíždí mi přijde jako dost závažnej problém… třeba když se projíždí dlouhym seznamem a hledá se očima, tak se postupně otvíraj i ty co nechceš a tak…

grey napsal(a):

to že to nezajíždí mi přijde jako dost závažnej problém… třeba když se projíždí dlouhym seznamem a hledá se očima, tak se postupně otvíraj i ty co nechceš a tak…

Nemyslim si, podla mna je toto uz naprosto idealny stav, pretoze to neblika tak rapidne ako ked sa to rozbalovalo okamzite, teraz to caka rozumny interval kym sa rozbali. A najme ak chcem pozerat viacero metod naraz tak bz bolo blbe aby som nemohol mat rozbaleno viac naraz.

@Ondřej: +1

@vrtak-cz: Neprohazoval bych. Mám k tomu trochu sobecký důvod: častěji chodím do zdrojáků, než abych potřeboval kotvu, a protože se mi celá stránka nevleze na šířku na monitor (při rozlišení 1280×1024), tak se mi nechce pořád jezdit myší k vodorovnému posuvníku dole na stránce.

Ale kdyby se upravila šířka té stránky, tak by mi to bylo jedno=)

Rozbalování na kliknutí tam samozřejmě je.

Každopádně vidím, že jste s dokumentací spokojeni, když řešíte takové nesmysly, jako se sbalování :-))