Re: [myhdl-list] Another typo in docs

[Christopher F. <chr...@gm...>]

On 5/23/14 4:47 PM, Henry Gomersall wrote:
> On 23/05/14 21:55, Christopher Felton wrote:
>> On 5/23/2014 3:04 PM, Henry Gomersall wrote:
>>>> On 23/05/14 20:57, Christopher Felton wrote:
>>>>>>>>>> Would it make sense to convert the code snippets in the Sphinx
>>>>>>>>>> documentation to doctests so this can be picked up automatically? I can
>>>>>>>>>> have a bash at this if desired (certainly, the FSM one above would be
>>>>>>>>>> useful as a doctest).
>>>>>> Yes, I think this is a great idea, I actually have a
>>>>>> start on this.  I have a couple sections completed with
>>>>>> doctest.  If others agree I can create a PR with my
>>>>>> changes and then you can add to if you like:)
>>>>>>
>>>> Can you do a sibling pull request (I mean, is it possible)? It makes
>>>> sense to not replicate one another's work! Otherwise can you point me at
>>>> the relevant repository and I'll fork that?
>>>>
>> Yes, I can point you to a repo (it will be a little while).
>> I did this awhile ago, the work was originally done on the
>> 0.8dev branch.  It will need to be merged to 0.9.
>
> Great, just let me know when you have it.
>
> Cheers,
>
> Henry


Here are the merged changes - I don't know if this is
the final version/format desired but it is a starting
point, I merged it to the 0.9dev branch:

https://bitbucket.org/cfelton/myhdl_09dev_doctest/overview

One note of caution, I had made these changes a while
back on 0.8 branch.  I used mercurial to merge but which
all went well.  But when I pushed it back to the repo above
it indicated it had to create a new head.  Not 100% positive
if we want the closed/dead/hanging head pushed back to the
main repo.

If you fork/clone this make sure you update to the 0.9dev
branch

     >> hg up -C 0.9-dev

Regards,
Chris