yard

5Ciepło

1Odpowiedz

Udokumentowanie funkcji renderującej JSON na stoczni?

Jeśli mam funkcję zwracającą to: render :json => @orders.as_json(include: [{:user => {only: :id}}], :only => [:id, :status_id]) jestem dokumentujących to tak: # @return [JSON] includes the id, the o

ruby-on-rails ruby yard 2014-06-04

---

6Ciepło

1Odpowiedz

Dokument doc i `define_method`

Czy istnieje sposób komentowania metod zdefiniowanych w define_method w YardDoc? Próbowałem to: %w(one two three).each do |type| # The #{type} way # @return [String] the #{type} way def

ruby documentation yard 2015-02-09

---

14Ciepło

2Odpowiedz

Jak odbudować rdoc dla wszystkich zainstalowanych klejnotów?

Mam kilka klejnotów zainstalowanych w wielu lokalizacjach. Jaki jest trudny/łatwy sposób wygenerować/re-generate: rdoc dla tych wszystkich zainstalowanych perełki, wszystko na raz? yardoc dla wszystki

ruby rdoc yard 2010-06-30

---

30Ciepło

1Odpowiedz

Jak udokumentować zadania rake z YARD?

Chciałbym dołączyć informacje o zadaniach Rake w naszej aplikacji Rails. Do dokumentacji używamy YARD, a obecnie strony takie jak lib/tasks/development.rake pojawiają się domyślnie jako niesformatowan

ruby-on-rails ruby rake yard 2015-04-22

---

10Ciepło

1Odpowiedz

YARD: dokumentowanie metod klas dodanych przez dołączony moduł

Piszę dokumentację dla mojego klejnotu ruby ​​przy użyciu YARD. W moim gem, mam kod, który Wynika to wspólny wzór rubinowy, gdy moduł jest zawarte w klasie, a moduł nie tylko dodaje metody instancji,

ruby module class-method yard 2012-01-15

---

8Ciepło

1Odpowiedz

Wszystko Ruby dokumentacji niedostępny ze stoczni

Jeśli chcę zobaczyć dokumentację na temat moich klejnotów mogę zrobić: yard server --gems Jak mogę sprawdzić dokumentację biblioteki standardowej Ruby?

ruby yard 2011-12-01

---

5Ciepło

1Odpowiedz

Dokumenty z kaczkami z wieloma metodami w YARD

YARD pozwala mi określić typy dla parametrów metod i wartości zwracanych. Ponieważ bardzo lubię kucać, dobrze jest zauważyć, że YARD wspiera również definiowanie typów, określając metody, które muszą

ruby documentation yard 2012-02-03

---

5Ciepło

1Odpowiedz

ostrzegawczy w stoczni z @param tagu

starałem się udokumentować kodu Ruby przy użyciu yard i chociaż robię dokładnie to, co jest opisane here lub here # @param [Integer] the number of trials (>= 0) # @param [Float] success probability i

ruby documentation yard 2012-07-03

---

6Ciepło

1Odpowiedz

Jak YARD dokument to metoda, która zwraca nic

Mam metodę jak ten def self.import(file_name, opts = {}) które staram się dokumentować ze stoczni. Jednak jest to metoda, która jest w 100% efektem ubocznym (wiem, wiem, efekty uboczne, urgh!). Ale

ruby documentation yard 2014-09-07

---