Hello Here are some reference documentation I found really powerful, all information are here, presented the right way. Each have its different approach. I would be good that the Rust documentation use the same pattern for each doc.
- QT Doc: http://qt-project.org/doc/qt-4.8/qthread.html / http://qt-project.org/doc/qt-4.8/qatomicint.html (introduction parts are big, and place the context where to use each API, gives lot of examples) - Python documentation reference http://docs.python.org/2/library/urllib2.html (functions are ordered by importance) - Boost documentation ( http://www.boost.org/doc/libs/1_55_0/doc/html/date_time/gregorian.html) is exhaustive on some API, but extremely hard to read, mostly because they are divided in many pages. My 2 cents. Gaetan ----- Gaetan 2014-03-12 0:52 GMT+01:00 Erick Tryzelaar <erick.tryzel...@gmail.com>: > Thanks for this. This sounds great. We should form a group on Thursday at > the meetup and come up with that checklist. I can help track down the > doc-less APIs Friday night and some of Saturday too. > > > > On Mon, Mar 10, 2014 at 5:38 PM, Brian Anderson <bander...@mozilla.com>wrote: > >> Hey, >> >> As you may know, we've got our first doc sprint scheduled for Sunday, >> 12-4 Pacific time. We'll to set up the commons area at the SF office with >> pizza and turn on video conferencing for remoties. Before that day comes >> though we need to come up with some kind of plan, something that is simple >> and fun. >> >> Here's my strawman proposal for what we're going to do Sunday: >> >> We'll focus on API docs since those are bitesize units of work and >> extremely parallelizable. Before the event we come up with a checklist for >> what API docs should include, as well as a list of high-value API's with >> missing docs. >> >> Sunday we put that list on an etherpad, and let people claim individual >> functions, traits, etc. Additionally, we keep a 'scoreboard' to track who >> completes the most docs. Whoever has the most docs at the end wins (just >> pizza and accolades). >> >> Does this sound reasonable? Does anybody want to volunteer to 'run' the >> sprint (make the list of needed docs, help people find tasks, collect and >> upstream the results, etc.)? >> >> Regards, >> Brian >> _______________________________________________ >> Rust-dev mailing list >> Rust-dev@mozilla.org >> https://mail.mozilla.org/listinfo/rust-dev >> > > > _______________________________________________ > Rust-dev mailing list > Rust-dev@mozilla.org > https://mail.mozilla.org/listinfo/rust-dev > >
_______________________________________________ Rust-dev mailing list Rust-dev@mozilla.org https://mail.mozilla.org/listinfo/rust-dev
