Looking to learn and lend a hand

[John Arbash Meinel]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Spencer,

I'm glad to see you helping out. I'm replying on list, so that other
people can join in the discussion.

I don't know a lot about epydoc myself. The comment was posted by Andrew
Bennetts, who I've CC'd on this email.

It could simply be a newer version of epydoc is needed for proper support.

I can see it listed here:
http://epydoc.sourceforge.net/manual-fields.html

I don't see it say anything about creating custom output for it.

As near as I can tell, your work looks correct (":deprecated: foo").

Andrew, do you know any more?

John
=:->


Spencer Chastain wrote:
> 
> Hey John,
> 
> I got your email today.  I had noticed the trivial tag yesterday and had
> already started nosing around  those. 
> 
> There are only two.  I took 75700, regarding epydoc and a @deprecated:
> tag, to start with, thinking it would be trivial.
> 
> I've modified the symbol_versioning._decorate_docstring to edit the text
> the way I want ... but I see the text appear as-is in the generated
> html.  It makes me wonder if I'm not running epydoc the right way, but
> I've not seen a whole lot of info on it.  Right now I'm running:
> 
> epydoc -o api/html --format restructuredtext bzr bzrlib
> 
> But instead of seeing tags formatted in some fashion (like I expect to
> see when I use javadoc), the text all appears as is.  So for example, I
> see the following text in my html without any kind of formatting (above
> and beyond the formatting for the rest of the method description):
> NOTE: the string I added is first in the method (for the moment) and the
> original is still at the end
> 
> 
>       create( self, *args, **kwargs)
> 
> :deprecated: was deprecated in version 0.8.
> Create a workingtree for branch at directory.
> 
> If existing_directory already exists it must have a .bzr directory.
> If it does not exist, it will be created.
> 
> 
> This returns a new WorkingTree object for the new checkout.
> 
> TODO FIXME RBC 20060124 when we have checkout formats in place this
> should accept an optional revisionid to checkout [and reject this if
> checking out into the same dir as a pre-checkout-aware branch format.]
> 
> 
> XXX: When BzrDir is present, these should be created through that 
> interface instead.
> 
> This method was deprecated in version 0.8.
> 
> any insight into what's going on or what I'm missing or an example of
> good bzr generated epydoc (and the command that produced it) would be
> welcomed.
> 
> Thanks for any pointers ... this should-be trivial is giving me more
> trouble than I had expected.
> 
> --Spencer
> 
> On 3/17/07, *John Arbash Meinel* < john at arbash-meinel.com
> <mailto:john at arbash-meinel.com>> wrote:
> 
> Spencer Chastain wrote:
> 
>> I think I may be committing a faux pas since I'm coming to a project
>> where I'm unprepared to do much and have more questions than
> ability ...
> 
>> ... so with that in mind, please forgive my eagerness to learn
> more and
>> get involved.
> 
> Welcome. I hope you find your stay here pleasant, and we can convince
> you to stay around.
> 
> 
>> I'm learning python and bzr more or less at the same time for the
>> purposes of understanding them, but I've not actually had any reason
>> (beyond contrived and thus seemingly emptily examples/tutorials)
> to use
>> what I'm learning.
> 
>> So, with this email, I'm hoping the community can point me to a
> list of
>> simple to-do's or bugs that are lying around but are not "important
>> enough" right now to have been done, keeping in mind my inexperience.
>> If someone would like to volunteer to serve as a kind of mentor so I
>> don't feel like I need to come to the list as a last resort,
> that'd be
>> cool, too.
> 
> Well our bug tracker is available here:
> https://bugs.launchpad.net/bzr/+bugs
> <https://bugs.launchpad.net/bzr/+bugs>
> 
> I realize most are probably bigger than what you are looking for.
> 
> I've tried to tag some of them with 'trivial':
> 
> https://bugs.launchpad.net/bzr/+bugs?field.tag=trivial
> <https://bugs.launchpad.net/bzr/+bugs?field.tag=trivial>
> 
> Which are supposed to be simple bugs that new users can fix.
> 
> 
>> I'm not looking for any hand holding ... just looking some
> direction in
>> taking small steps into the shallow end of the pool before diving into
>> the deep end.
> 
> 
> Another good place to go is IRC ( chat.freenode.net
> <http://chat.freenode.net> channel #bzr.) It is
> usually pretty active (a bit quieter on weekends), and I try to hang
> out
> there and give advice when I can.
> 
> 
>> I've read a lot of the blueprints and bug reports in the bug
> tracker ...
>> I'm just not seeing things that are not already in-work to some degree
>> (based largely on comments I see in the bug reports, not so much
> on the
>> reported status of said bug) that I'd be comfortable taking
> on.  If some
>> of these low-priority/easy bugs are in fact available to be worked
>> despite comments seemingly to the contrary, I'd be happy to work
> them -
>> just point them out to me so I know.
> 
>> Again, not looking for a whole lot - just a little direction and
>> instruction above and beyond what I've read (...I've basically been
>> reading through bazaar-vcs.org <http://bazaar-vcs.org>
> <http://bazaar-vcs.org > the past
>> month...) to get myself into things a little more.
> 
>> I appreciate any feedback,
> 
>> --Spencer
> 
> 
> Feel free to ask specific questions as you come across them.
> 
> John
> =:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFF/M+ZJdeBCYSNAAMRAgSLAKCVJYtAKl9C1elpfpjtkBkbYCgMrwCfTRSK
QExzxB7Vj6VV+9bP4ThzPto=
=1n3S
-----END PGP SIGNATURE-----