Hmm. I tried sending this yesterday (with a draft of a patch attached)
but it seems like it didn't make it through. Apologies if both versions
somehow /do /come through.
This time I just uploaded the patch of my changes so far to here:
http://wiki.openqa.org/pages/viewpageattachments.action?pageId=2068
==================================================
Hey all, I think it's time for an rdoc progress report.
*
**Done:*
changes.rb - split out from readme.rb, and updated from Jira
license.rb - split out from readme.rb
readme.rb
* Deleted changes, license, and to-do list.
* Added examples of identifying elements with 2 identifying
characteristics.
watir.rb
* Updated button method with additional hows (:class, :text),
additional Typical Usage, examples of accessing an element with
multiple attributes, and an example of accessing a button nested
within another element. (I am considering whether to do this for
all Elements, or to use a different tactic. See my questions, below.)
* Other minor, mostly typographical changes
*Questions:
*changes.rb and license.rb
* What do I need to do so that these will be listed in the rdoc (as
they are for rspec and rails)? When I rolled my own rdoc, I don't
see these under Files.
changes.rb
* This list is all features, improvements, and bugs listed in Jira
for Watir 1.5, with a resolution of fixed + unresolved ones. It
excludes tasks, sub-tasks, and anything with a resolution other
than fixed. Is this what we want?
* All all our new features included on this list? (e.g. It seems
that modal dialog support is NOT obviously a part of any of these
features or improvements. Do we have new features without
corresponding Jira items?)
watir.rb
* :method and :action are listed as permissible 'how' types for the
initialize method. What do they mean? Where else are they usable?
* Think about how best to lay out hows & whats. Please comment.
o The current strategy is to list every how value for each
element, with usage hints. (My edits to button are in
keeping with this strategy.)
+ Benefits: This has the benefit of having a lot of
information right by each Element method, including
examples specific to that Element.
+ Downside: more work to maintain in multiple places,
and more opportunities for information to get out of sync.
o An alternate strategy (mentioned by Brett in an earlier
email) would be to centralize this information - somewhere
in the rdoc or on the wiki - with links to it from each Element.
+ Benefit: easier to maintain, can't get out of sync.
Also a less verbose rdoc.
+ Possibly not as clear for someone unfamiliar with Watir.
readme.rb
* Zeljko, do you know where the new User Guide will live? For now
I'm linking to Jonathan's old one at:
http://wtr.rubyforge.org/watir_user_guide.html
I've attached a patch of all the changes I've made so far so that
interested folks can check it out. (BTW, this is the first patch I've
created, and I was surprised to see that it's just a txt file. If this
/isn't /correct, please let me know. I created it using these
instructions
<http://svn.collab.net/subclipse/help/index.jsp?topic=/org.tigris.subversion.subclipse.doc/html/reference/create-patch.html>.)
Cheers,
Jeff
http://testingjeff.wordpress.com
_______________________________________________
Wtr-general mailing list
[email protected]
http://rubyforge.org/mailman/listinfo/wtr-general
