Loren Segal - Documentation with YARD
- Yet Another Ruby Documentor
- Talk about documentation in general
- Documentation to help you think about your API
- What makes documentation good?
- consistency -> pick a style and stick with it
- correct -> it can be wrong and should be audited
- coherent
- YARD
- meta-data
- @ param [Symbol] req_type :get or :post
- ....
- yard-respec
- shows rspec specs alongside method docs …
…SketchFlow, and more... Roundup of WPF Documentation Samples Some good stuff in here; Snoop = " Firebug for WPF", Inkscape = vector graphics editor... Write code to enter the NASA Pathfinder Innovation Challenge There are dozens of coding competitions out there at any given time, but we thought this one was really cool - you can either build a " mechanical Turk " game or an image recognition application. And c'mon... …
You should read Chef's Documentation on Cookbooks to have a better understanding. Another way is to git clone Opscode and 37signals (or even mine) cookbook and read one by one to try to get the gist of it. To make it easier, you have to know this:
Most well written recipes will have a metadata.rb , metadata.json and at least a README . rdoc files. You should read them to get more information on a particular recipe.
If your recipe has an attributes directory, you know …
… Webrat:: XML.html document(response) doc.search('script').remove puts Webrat:: XML.inner text(doc)
Gives: Ruby on Rails Overview | Download | Deploy | Code | Screencasts | Documentation | Ecosystem | Community | Blog ......................................... ...
…/// <param name= "number" >An integer input</param> /// <returns>Returns a <see cref="string"> based on the provided /// number /// </returns> public string GetSomething ( int number ) { ... }
That's not that painful is it?
Pathfinder is a software development firm. Hire us to build complex software that's easy to use.
C# Documentation (It ain't that hard)
The chef-deploy project written originally by Ezra Zygmuntowicz to bring Capistrano-strategy deployment to Chef has been ported to Chef proper. The SCM functionality has additionally been extracted into Git and Subversion resources. I'm increasingly excited by the prospects opened by having deployment and scm functionality available as first class citizens in Chef, and hope we can continue to offer more enhancements such …
…unsure, check your driver documentation. A good place to look for docs is in your kernel source under Documentation, available on the web here: http://lxr.linux.no/linux+v2.6.30/Documentation/networking/ but be sure to select the correct kernel version, first!
Older e1000 drivers (newer drivers, do nothing) : make CFLAGS EXTRA=-DE1000 NAPI install
Throttle NIC Interrupts
Some drivers allow the user to specify the rate at which the NIC will generate interrupts. The e1000e …
…best bet and well worth the effort of installing and configuring.
However, when it comes to simplicity and time versus performance I think the benefits to trying out fuzzy string matching are tangible.
Further Reading
PostgreSQL Documentation on Fuzzy String Matching
PostgreSQL Documentation on pg_trgm
…programming languages (** Ruby**, Python, PHP, Perl), Documentation on the Ruby binding is definitely lacking, Luckily, It provides pretty much all core C++ class and methods wrapped in Ruby.
** Xapit** [ Xapit][5]( pronounce as "zap it" ) is a new high level search library developed by RyanB, High level Ruby library for interacting with Xapian, a full text search engine that is in Ruby and most importantly ** ORM agnostic**.
It includes a AbstractAdapter…
Episode 82. Another week of useful news and libraries for any Ruby or Rails developer, this week co-hosted by Nathaniel Bibler .
Subscribe via iTunes - iTunes only link.
Download the podcast ~11:00 mins MP3 .
Subscribe to feed via RSS by copying the link to your RSS Reader
Show Notes
Rails security problem with authenticate_with_http_digest
Trample: A better load simulator