rdoc Questions

1

Solved

I don't remember where I learned the !~ method of the String class. However I know it compares a string to a regex and check whether the string not match the regex. See my below example. C:\>ir...
Elah asked 22/12, 2012 at 8:25

2

Solved

Rubyinside mentioned a blog post on how to speed up gem installation by not installing RI or RDoc. Is it possible to install a gem and subsequently install documentation at a later date, so you c...
Thirdrate asked 20/3, 2009 at 1:13

2

Solved

Just a forewarning: I'm a rails noob. When I run: rake db:migrate I get this deprecation warning: WARNING: 'require 'rake/rdoctask'' is deprecated. Please use 'require 'rdoc/task' (in RDoc 2.4...
Thor asked 2/1, 2012 at 15:25

5

I just installed rvm and then rails 3.1rc5 with: gem install rails --pre But I got some errors after "Installing ri documentation" and the RDoc documentation: Successfully installed <bunch o...
Chicane asked 4/8, 2011 at 8:57

9

Solved

I can do sudo gem rdoc activerecord --no-ri and sudo gem rdoc actionpack --no-ri both of which give me good docs. But sudo gem rdoc rails --no-ri gives me pretty much nothing, as the Rai...
Ostensible asked 29/7, 2009 at 18:12

1

Solved

I am using class_eval to define a bunch of repetitive methods more concisely, something like this: %w{greasy chunky bacon}.product(%w{flying sky poodle}).each do |a,b| class_eval "def #{a}_#{b}; ...
Zandrazandt asked 13/8, 2012 at 2:27

3

Solved

Over the last week, on a few gem install or gem update operations, I've received an error similar to these: ERROR: While generating documentation for sinatra-1.3.1 ... MESSAGE: error generating C...
Exceptional asked 25/10, 2011 at 23:37

1

Solved

Is there something like javadoc or rdoc for documenting YAML files, so that we could extract it into HTML documentation? Ideally with markdown syntax.
Vivl asked 5/7, 2011 at 18:50

3

I use bdoc (with hanna for formatting) as a quick way of looking at the rdoc documentation for the gems installed on my system. However, because bundler does not install rdoc when installing gems, ...
Pyroxylin asked 23/2, 2011 at 17:42

2

Solved

I'm not sure if this is actually possible or not but I'm trying to make the documentation of our rails app more complete by adding documentation for the scopes in our app/models files. What I'm loo...
Catastrophe asked 1/9, 2011 at 17:11

1

Possible Duplicate: ruby 1.9 ri problem When I try to use Ruby's ri tool in a command prompt window to get help about classes, methods, etc. it seems to always fail. For example if I ...
Zimmermann asked 15/10, 2009 at 22:3

2

I am trying to contribute to a gem I recently took interest in - Nesta. The developer has done a great job in creating one of the lightest, thinest CMSs you can find and I want to document it. I ha...
Radioman asked 25/4, 2011 at 8:10

2

Solved

I just started to document a rails application. I know this is actually done by rdoc, so I followed some rdoc guides regarding syntax and so on, but I got stuck when I tried to describe attributes ...
Cherianne asked 2/11, 2010 at 2:15

1

Solved

I'm currently switching from rdoc to yard for my ruby software documentaion. In my doc I often reference some classes/modules from the comments, for instance : ## == Provides various utility fea...
Degradable asked 16/9, 2010 at 8:55

2

Solved

I have several gems installed in multiple locations. What is the hard/easy way to generate/re-generate: rdoc for all these installed gems, all at once? yardoc for all these installed gems, all ...
Ejaculatory asked 30/6, 2010 at 19:47

1

Solved

Correct me if I'm wrong, is YARD not the same as RDoc? It's not based on RDoc but a total rewrite? So if I'm using YARD, I don't have to bother with RDoc right?
Threeply asked 13/9, 2010 at 10:50

2

Solved

For example, I've always seen methods referred to as String#split, but never String.split, which seems slightly more logical. Or maybe even String::split, because you could consider #split to be in...
Slotter asked 26/6, 2010 at 9:57

1

Solved

What do these errors mean? [root@localhost config]# gem install bluecloth Building native extensions. This could take a while... ERROR: Error installing bluecloth: ERROR: Failed to build gem nati...
Sapphism asked 25/5, 2010 at 12:36

2

I want to format my existing comments as 'RDoc comments' so they can be viewed using ri. What are some recommended resources for starting out using RDoc?
Downpour asked 1/8, 2008 at 13:38

© 2022 - 2024 — McMap. All rights reserved.