I am willing to help also but i find it quite hard to setup the environnement properly. Is these a tutorial for this point? Le 19 nov. 2013 14:58, "Philippe Delrieu" <[email protected]> a écrit :
> I'am ok to add sample code in json.rs. > how can I do? > I think I will have other sample code for other lib in a few days. I'll > wait that the lib is open to doc enhancement or I put it as it come and how > can it be managed. > > Philippe > > Le 19/11/2013 14:48, Gaetan a écrit : > > Also, what we set up in our scrum team is "targetted" doc stories inside > each sprint. > > Let's say that over the next month, the objective is to improve a set of > module doc, ie, a list of very useful std or extra lib that is not properly > documented. > For instance, the next month we target on improving json or extra::path, > and enhance them until they become golden star level. And the next month or > sprint, we focus on other modules > > It's easier to focus people like this that just telling "you can take > whichever module you want and improve them". It just work better, we > discovered. > > ----- > Gaetan > > > > 2013/11/19 Gaetan <[email protected]> > >> I think it's better to enhance the extra::json lib itself and write >> proper module documentation, with samples, use case etc. >> My reference is the QT documentation. You never open and samples or even >> the QT source code, everything is in the module documentation. >> >> ----- >> Gaetan >> >> >> >> 2013/11/19 Philippe Delrieu <[email protected]> >> >>> Hello, >>> >>> I would like to share my experience about the Rust doc and the tutorial. >>> I've just started to learn Rust and I've decided to use it on a project I >>> work on. Like everybody I read the Rust tutorial. It's not a really a >>> tutorial for beginner but it do a good job in presenting Rust and its mains >>> concept. I found other tutorial on the web and in my opinion what is >>> missing the more is sample code. The Rust lib is huge and there is no code. >>> In my project I have to use Json serialization. So I wanted to use the json >>> lib in extra lib and I really spend some time to make a simple code works. >>> I was very near to write my own lib. json.rs is a little complicated >>> for a newbie. There are some test case at the end but it tests the lib and >>> not what I want to do with it. For example there is no serialization of an >>> object. I search the web and I found some old example (not compatible with >>> the master lib) and no object serialization. >>> >>> So what I think is that it would be great is to construct a repository >>> of sample code of the Rust lib that show how to use the lib. I'm ok to >>> write and maintain some sample like one on json. I think it would be great >>> to host all these sample in the same repository and to have the same >>> organization for all sample. The second reason tu use a share repository is >>> that the sample has to be made in the spirit of Rust to help understand it. >>> For that the sample must be checked and modified by more experienced rust >>> developer. It's easier when the code is in a common repository. >>> >>> Pḧilippe >>> >>> _______________________________________________ >>> Rust-dev mailing list >>> [email protected] >>> https://mail.mozilla.org/listinfo/rust-dev >>> >> >> > >
_______________________________________________ Rust-dev mailing list [email protected] https://mail.mozilla.org/listinfo/rust-dev
