On 1/25/08, Firas Abbas <[EMAIL PROTECTED]> wrote: > Attached is a GNU Radio Documentation Patch.
Thanks for the continued work. This patch needs to be reworked, however. The majority of your changes to the python scripts are to move the docstring from the __init__ function to the class definition line. While the effect of this is to put the class description in the right place for the doc generator, it also incorrectly moves the __init__ parameter documentation from where it needs to stay. In other words, please *split* the docstring in __init__ into two pieces. The first should contain the class description and be moved to the class definition. The remaining parameter markup should stay in the __init__ docstring. Also, I noticed a fair amount of gratuitous whitespace changes, which probably result from the editor you are using and how it handles tabs vs. spaces. Please minimize these changes, as they make it more difficult to merge other patches in future that may be based on an older version of the file. When making changes to a file that has a copyright header, please add the current year to the file if it is not already 2008. Finally, for submitting patch files, it is not necessary to put a single patch into a tarball. If it is relatively small (say, < 10K), just attach the diff file to your mail. If it is larger, use gzip or bzip2 to compress it first to save bandwidth. Thanks again for your work in improving GNU Radio documentation. -- Johnathan Corgan Corgan Enterprises LLC http://corganenterprises.com/ _______________________________________________ Patch-gnuradio mailing list [email protected] http://lists.gnu.org/mailman/listinfo/patch-gnuradio
