On 02/27/2013 10:49 AM, Dan CaJacob wrote: > Really great documentation would be nice. I know that it has been > improving, but maybe GSOC is an excuse for a sprint? Ideally, the > documenter is someone who really knows DSP and what is going on behind the > curtains.
GSoC is for code related work, not documentation work. However, a proposal to write some code that would improve usability should be OK. Philip > > References to examples in the documentation would help out immensely. I > often resort to hunting down a block's source code or other blocks and > examples that use the block to understand it. > > I have always wanted an auto-magically generated list of references to > other blocks/examples that use the block being documented. I think this > would be easy to do in python. When building the docs, a script could > search for instances of each block in other blocks and examples, then > insert them as references in the block's documentation. > > As someone with little DSP backrground, I would like to be able to see some > great documentation when I open up a block in GRC or introspect it in > python. > > Very Respectfully, > > Dan CaJacob > > -- This email contains sensitive proprietary and confidential information. > The technical data contained herein is/may be controlled under the U.S. > International Traffic in Arms Regulations (ITAR) and may not be exported to > a Foreign Person, either in the U.S. or abroad, without the proper > authorization by the U.S. Department of State. -- > > > On Wed, Feb 27, 2013 at 12:39 PM, Martin Braun (CEL) > <martin.br...@kit.edu>wrote: > >> Ideas, ideas, ideas! >> >> Everyone, we need ideas. >> The GSoC application deadline is coming closer, and we still are lacking >> some ideas. >> >> So what cool feature of GNU Radio are *you* missing? >> >> Head over here, and write them down: >> http://gnuradio.org/redmine/projects/gnuradio/wiki/GSoC >> >> At this point, any random idea is OK. Also, you're not signing up for >> anything if you post an idea. >> >> MB >> >> -- >> Karlsruhe Institute of Technology (KIT) >> Communications Engineering Lab (CEL) >> >> Dipl.-Ing. Martin Braun >> Research Associate >> >> Kaiserstraße 12 >> Building 05.01 >> 76131 Karlsruhe >> >> Phone: +49 721 608-43790 >> Fax: +49 721 608-46071 >> www.cel.kit.edu >> >> KIT -- University of the State of Baden-Württemberg and >> National Laboratory of the Helmholtz Association >> >> _______________________________________________ >> Discuss-gnuradio mailing list >> Discuss-gnuradio@gnu.org >> https://lists.gnu.org/mailman/listinfo/discuss-gnuradio >> >> > > > > _______________________________________________ > Discuss-gnuradio mailing list > Discuss-gnuradio@gnu.org > https://lists.gnu.org/mailman/listinfo/discuss-gnuradio > _______________________________________________ Discuss-gnuradio mailing list Discuss-gnuradio@gnu.org https://lists.gnu.org/mailman/listinfo/discuss-gnuradio