Re: [myhdl-list] docstrings forwarded to converted output
Brought to you by:
jandecaluwe
From: Angel E. <ang...@gm...> - 2010-07-01 20:15:24
|
> On Tue, Jun 29, 2010 at 4:47 PM, Jan Decaluwe <jan <at> jandecaluwe.com> wrote:I just pushed a changeset which is supposed to add support > for forwarding docstrings to converted output. > This provides a way to document the converted output. > Ordinary Python comments are ignored, because they are > not kept in the ast tree generated by the ast module. > But any docstring is forwarded. Those on "official places" > are put on a hopefully logical position, but "unofficial" > ones are forwarded also, right on the line where they > occur. By using a docstring instead of an ordinary comment, > you can control which comments should be kept by the > conversion, and which not. > This is an experimental feature, not extensively tested. > Let us know what you find. > Jan Jan, I just gave this a try but it does not work for me. I download the latest version from the mercurial repository and then I ran the rom.py example. This example has some docstrings and also calls toVHDL, so I figured that it would generate a rom.vhd file which should have the docstring (as a comment?). However there is no trace of the docstring on the vhdl output. Is there something that I should do to enable this feature? Or am I doing something wrong? Cheers, Angel P.S.- Jan, I'm the same Angel you've been exchanging emails these past few days. This is my "public" email address. |