Gecko [ beriskala.com ]

Name	Size	Permission	Date
ACL	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ARGF	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Abbrev	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Addrinfo	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ArgumentError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Array	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Base64	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
BasicObject	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
BasicSocket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Benchmark	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
BigDecimal	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
BigMath	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Binding	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Bundler	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
CGI	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
CSV	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Class	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ClosedQueueError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Comparable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Complex	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ConditionVariable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Continuation	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
CoreExtensions	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Coverage	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
DBM	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
DBMError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
DEBUGGER__	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
DRb	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Date	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
DateTime	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Delegator	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
DidYouMean	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Digest	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Dir	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ENV	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
EOFError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ERB	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
EXCEPTION_TYPE	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Encoding	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
EncodingError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
English	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Enumerable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Enumerator	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Errno	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Etc	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Exception	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ExceptionForMatrix	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
FalseClass	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Fcntl	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Fiber	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
FiberError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Fiddle	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
File	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
FileTest	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
FileUtils	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Find	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Float	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
FloatDomainError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Forwardable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
FrozenError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
GC	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
GDBM	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
GDBMError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
GDBMFatalError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Gem	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
GetoptLong	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPClientException	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPGatewayTimeOut	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPMovedTemporarily	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPMultipleChoice	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPRequestEntityTooLarge	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPRequestTimeOut	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPRequestURITooLarge	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPRequestURITooLong	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
HTTPRequestedRangeNotSatisfiable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Hash	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
IO	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
IOError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
IPAddr	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
IPSocket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
IRB	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
IndexError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Integer	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Interrupt	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
JSON	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Jacobian	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Kconv	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Kernel	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
KeyError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
LUSolve	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
LoadError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
LocalJumpError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Logger	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
MakeMakefile	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Marshal	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
MatchData	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Math	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Matrix	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Method	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Module	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Monitor	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
MonitorMixin	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Mutex	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Mutex_m	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NKF	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NameError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Net	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Newton	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NilClass	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NoMatchingPatternError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NoMemoryError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NoMethodError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
NotImplementedError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Numeric	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
OLEProperty	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Object	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ObjectSpace	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Observable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Open3	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
OpenSSL	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
OpenStruct	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
OpenURI	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
OptionParser	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
PP	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
PStore	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
PTY	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Pathname	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Pool	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
PrettyPrint	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Prime	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Proc	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Process	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Psych	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Queue	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RDoc	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RDocTask	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Racc	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Ractor	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Rake	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Random	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Range	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RangeError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Rational	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RbConfig	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Readline	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Regexp	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RegexpError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Reline	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Resolv	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Rinda	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Ripper	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RubyLex	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RubyVM	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
RuntimeError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SOCKSSocket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ScriptError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SecureRandom	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SecurityError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Set	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Shellwords	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Signal	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SignalException	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SimpleDelegator	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SingleForwardable	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Singleton	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SizedQueue	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Socket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SocketError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
StandardError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
StopIteration	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
String	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
StringIO	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
StringScanner	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Struct	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Symbol	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SyntaxError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Syslog	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SystemCallError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SystemExit	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
SystemStackError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
TCPServer	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
TCPSocket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
TSort	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Tempfile	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Thread	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ThreadError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ThreadGroup	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Time	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Timeout	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
TracePoint	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Tracer	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
TrueClass	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
TypeError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
UDPSocket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
UNIXServer	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
UNIXSocket	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
URI	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
UnboundMethod	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
UncaughtThrowError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
UnicodeNormalize	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Vector	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLEQueryInterfaceError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLERuntimeError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_EVENT	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_METHOD	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_PARAM	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_RECORD	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_TYPE	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_TYPELIB	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_VARIABLE	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WIN32OLE_VARIANT	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Warning	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
WeakRef	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Win32	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
XMP	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
YAML	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
ZeroDivisionError	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
Zlib	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
fatal	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
lib	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
syntax	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
win32	[ DIR ]	drwxr-xr-x	2026-05-01 04:23
cache.ri	291 KB	-rw-r--r--	2024-06-26 17:25
page-CONTRIBUTING_md.ri	358 B	-rw-r--r--	2024-06-26 17:25
page-COPYING.ri	3.06 KB	-rw-r--r--	2024-06-26 17:25
page-COPYING_ja.ri	3.16 KB	-rw-r--r--	2024-06-26 17:25
page-LEGAL.ri	48.36 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-1_8_7.ri	22.05 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-1_9_1.ri	17.56 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-1_9_2.ri	20.67 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-1_9_3.ri	14.91 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_0_0.ri	26.03 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_1_0.ri	18.2 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_2_0.ri	16.89 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_3_0.ri	17.8 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_4_0.ri	16.02 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_5_0.ri	23.8 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_6_0.ri	24.97 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS-2_7_0.ri	31.66 KB	-rw-r--r--	2024-06-26 17:25
page-NEWS_md.ri	30.46 KB	-rw-r--r--	2024-06-26 17:25
page-README_ja_md.ri	10.93 KB	-rw-r--r--	2024-06-26 17:25
page-README_md.ri	8.33 KB	-rw-r--r--	2024-06-26 17:25
page-bug_triaging_rdoc.ri	4.83 KB	-rw-r--r--	2024-06-26 17:25
page-contributing_rdoc.ri	20.87 KB	-rw-r--r--	2024-06-26 17:25
page-dig_methods_rdoc.ri	3.66 KB	-rw-r--r--	2024-06-26 17:25
page-dtrace_probes_rdoc.ri	9.92 KB	-rw-r--r--	2024-06-26 17:25
page-extension_ja_rdoc.ri	85.53 KB	-rw-r--r--	2024-06-26 17:25
page-extension_rdoc.ri	86.75 KB	-rw-r--r--	2024-06-26 17:25
page-fiber_md.ri	5.72 KB	-rw-r--r--	2024-06-26 17:25
page-globals_rdoc.ri	5.82 KB	-rw-r--r--	2024-06-26 17:25
page-implicit_conversion_rdoc.ri	7.22 KB	-rw-r--r--	2024-06-26 17:25
page-keywords_rdoc.ri	6.29 KB	-rw-r--r--	2024-06-26 17:25
page-maintainers_rdoc.ri	15.36 KB	-rw-r--r--	2024-06-26 17:25
page-make_cheatsheet_md.ri	3.44 KB	-rw-r--r--	2024-06-26 17:25
page-marshal_rdoc.ri	14.17 KB	-rw-r--r--	2024-06-26 17:25
page-memory_view_md.ri	8.85 KB	-rw-r--r--	2024-06-26 17:25
page-method_documentation_rdoc.ri	8.95 KB	-rw-r--r--	2024-06-26 17:25
page-ractor_md.ri	31.38 KB	-rw-r--r--	2024-06-26 17:25
page-regexp_rdoc.ri	35.68 KB	-rw-r--r--	2024-06-26 17:25
page-security_rdoc.ri	7.09 KB	-rw-r--r--	2024-06-26 17:25
page-signals_rdoc.ri	4.96 KB	-rw-r--r--	2024-06-26 17:25
page-standard_library_rdoc.ri	9.17 KB	-rw-r--r--	2024-06-26 17:25
page-syntax_rdoc.ri	1.88 KB	-rw-r--r--	2024-06-26 17:25

Rename

U:RDoc::TopLevel[	i�I"method_documentation.rdoc:EFcRDoc::Parser::Simpleo:RDoc::Markup::Document:@parts[aS:RDoc::Markup::Heading:
leveli:	textI"Method Documentation Guide;To:RDoc::Markup::BlankLine�o:RDoc::Markup::Paragraph;[I"PThis guide discusses recommendations for documenting methods for Ruby core ;TI"1classes and classes in the standard library.;T@
S;	;
i;I"	Goal;T@
o;
;[
I"HThe goal when documenting a method is to impart the most important ;TI"Iinformation about the method in the least amount of time.  A reader ;TI"Fof the method documentation should be able to quickly understand ;TI"Hthe purpose of the method and how to use it.  Providing too little ;TI"Iinformation about the method is not good, but providing unimportant ;TI"Ginformation or unnecessary examples is not good either.  Use your ;TI"Ijudgment about what the user of the method needs to know to use the ;TI"method correctly.;T@
S;	;
i;I"General Structure;T@
o;
;[I"AThe general structure of the method documentation should be:;T@
o:RDoc::Markup::List:
@type:BULLET:@items[o:RDoc::Markup::ListItem:@label0;[o;
;[I"(call-seq (for methods written in C);To;;0;[o;
;[I"!Synopsis (Short Description);To;;0;[o;
;[I"Details and Examples;To;;0;[o;
;[I"(Argument Description (if necessary);To;;0;[o;
;[I" Corner Cases and Exceptions;To;;0;[o;
;[I"Aliases;To;;0;[o;
;[I"Related Methods (optional);T@
S;	;
i;I"(call-seq (for methods written in C);T@
o;
;[I"DFor methods written in C, RDoc cannot determine what arguments ;TI"@the method accepts, so those need to be documented using a ;TI"=<tt>call-seq</tt>.  Here's an example <tt>call-seq</tt>:;T@
o:RDoc::Markup::Verbatim;[	I"*  call-seq:
;TI"!*    array.count -> integer
;TI"&*    array.count(obj) -> integer
;TI"2*    array.count {|element| ... } -> integer
;T:@format0o;
;[I"6When creating the <tt>call-seq</tt>, use the form;T@
o;;[I"Mreceiver_type.method_name(arguments) {|block_arguments|} -> return_type
;T;0o;
;[I"POmit the parentheses for cases where the method does not accept arguments, ;TI"@and omit the block for cases where a block is not accepted.;T@
o;
;[I"QIn the cases where method can return multiple different types, separate the ;TI"Ptypes with "or".  If the method can return any type, use "object".  If the ;TI"-method returns the receiver, use "self".;T@
o;
;[	I"SIn cases where the method accepts optional arguments, use a <tt>call-seq</tt> ;TI"Twith an optional argument if the method has the same behavior when an argument ;TI"Uis omitted as when the argument is passed with the default value.  For example, ;TI"	use:;T@
o;;[I"G*     obj.respond_to?(symbol, include_all=false) -> true or false
;T;0o;
;[I"Instead of:;T@
o;;[I"4*     obj.respond_to?(symbol) -> true or false
;TI"A*     obj.respond_to?(symbol, include_all) -> true or false
;T;0o;
;[I"QHowever, as shown above for <tt>Array#count</tt>, use separate lines if the ;TI"6behavior is different if the argument is omitted.;T@
o;
;[I"$Omit aliases from the call-seq.;T@
S;	;
i;I"
Synopsis;T@
o;
;[	I"EThe synopsis comes next, and is a short description of what the ;TI"Bmethod does and why you would want to use it.  Ideally, this ;TI"Gis a single sentence, but for more complex methods it may require ;TI"an entire paragraph.;T@
o;
;[I"/For <tt>Array#count</tt>, the synopsis is:;T@
o;;[I",Returns a count of specified elements.
;T;0o;
;[I"FThis is great as it is short and descriptive.  Avoid documenting ;TI"Gtoo much in the synopsis, stick to the most important information ;TI"#for the benefit of the reader.;T@
S;	;
i;I"Details and Examples;T@
o;
;[I"HMost non-trivial methods benefit from examples, as well as details ;TI"Hbeyond what is given in the synopsis.  In the details and examples ;TI"Fsection, you can document how the method handles different types ;TI"Cof arguments, and provides examples on proper usage.  In this ;TI"Fsection, focus on how to use the method properly, not on how the ;TI"7method handles improper arguments or corner cases.;T@
o;
;[I"HNot every behavior of a method requires an example.  If the method ;TI"Jis documented to return +self+, you don't need to provide an example ;TI"Jshowing the return value is the same as the receiver.  If the method ;TI"Iis documented to return +nil+, you don't need to provide an example ;TI"Gshowing that it returns +nil+.  If the details mention that for a ;TI"Gcertain argument type, an empty array is returned, you don't need ;TI"$to provide an example for that.;T@
o;
;[	I"IOnly add an example if it provides the user additional information, ;TI"Edo not add an example if it provides the same information given ;TI"Jin the synopsis or details.  The purpose of examples is not to prove ;TI""what the details are stating.;T@
S;	;
i;I"(Argument Description (if necessary);T@
o;
;[
I"KFor methods that require arguments, if not obvious and not explicitly ;TI"Kmentioned in the details or implicitly shown in the examples, you can ;TI"Nprovide details about the types of arguments supported.  When discussing ;TI"Lthe types of arguments, use simple language even if less-precise, such ;TI"Nas "level must be an integer", not "level must be an Integer-convertible ;TI"Oobject".  The vast majority of use will be with the expected type, not an ;TI"Gargument that is explicitly convertible to the expected type, and ;TI"1documenting the difference is not important.;T@
o;
;[I"LFor methods that take blocks, it can be useful to document the type of ;TI"Kargument passed if it is not obvious, not explicitly mentioned in the ;TI"7details, and not implicitly shown in the examples.;T@
o;
;[I"GIf there is more than one argument or block argument, use an RDoc ;TI"definition list:;T@
o;;:	NOTE;[o;;[I"argument_name1 ;T;[o;
;[I"type and description;To;;[I"argument_name2 ;T;[o;
;[I"type and description;T@
S;	;
i;I" Corner Cases and Exceptions;T@
o;
;[I"JFor corner cases of methods, such as atypical usage, briefly mention ;TI"3the behavior, but do not provide any examples.;T@
o;
;[
I"LOnly document exceptions raised if they are not obvious.  For example, ;TI"Jif you have stated earlier than an argument type must be an integer, ;TI"Myou do not need to document that a TypeError is raised if a non-integer ;TI"Kis passed.  Do not provide examples of exceptions being raised unless ;TI"@that is a common case, such as Hash#fetch raising KeyError.;T@
S;	;
i;I"Aliases;T@
o;
;[I"PMention aliases in the form "Array#find_index is an alias for Array#index.";T@
S;	;
i;I"Related Methods (optional);T@
o;
;[I"JIn some cases, it is useful to document which methods are related to ;TI"Gthe current method.  For example, documentation for Hash#[] might ;TI"Jmention Hash#fetch as a related method, and Hash#merge might mention ;TI"I#merge! as a related method.  Consider which methods may be related ;TI"Jto the current method, and if you think the reader would benefit it, ;TI"Fat the end of the method documentation, add a line starting with ;TI"G"Related: " (e.g. "Related: #fetch").  Don't list more than three ;TI"Hrelated methods. If you think more than three methods are related, ;TI"Fpick the three you think are most important and list those three.;T@
S;	;
i;I".Methods Accepting Multiple Argument Types;T@
o;
;[I"KFor methods that accept multiple argument types, in some cases it can ;TI"Jbe useful to document the different argument types separately.  It's ;TI"Gbest to use a separate paragraph for each case you are discussing.;T@
S;	;
i;I"Use of English;T@
o;
;[I"JReaders of this documentation may not be native speakers of English. ;TI"7Documentation should be written with this in mind.;T@
o;
;[I"LUse short sentences and group them into paragraphs that cover a single ;TI"Ktopic.  Avoid complex verb tenses, excessive comma-separated phrases, ;TI"and idioms.;T@
o;
;[	I"HWhen writing documentation, define unusual or critical concepts in ;TI"Hsimple language.  Provide links to authoritative sources, or add a ;TI"Igeneral description to the top-level documentation for the class or ;TI"module.;T@
S;	;
i;I"Formatting;T@
o;
;[
I"KExtraneous formatting such as headings and horizontal lines should be ;TI"Iavoided in general.  It is best to keep the formatting as simple as ;TI"Lpossible.  Only use headings and other formatting for the most complex ;TI"Mcases where the method documentation is very long due to the complexity ;TI"of the method.;T@
o;
;[I"8Methods are documented using RDoc syntax.  See the ;TI"~{RDoc Markup Reference}[https://docs.ruby-lang.org/en/master/RDoc/Markup.html#class-RDoc::Markup-label-RDoc+Markup+Reference] ;TI"9for more information on formatting with RDoc syntax.;T:
@file@:0@omit_headings_from_table_of_contents_below0