jira.codehaus.org

  • Log In Access more options
    • Online Help
    • Keyboard Shortcuts
    • About JIRA
    • JIRA Credits
    • What?s New
  • Dashboards Access more options (Alt+d)
  • Projects Access more options (Alt+p)
  • Issues Access more options (Alt+i)
  • JBehave
  • JBEHAVE-174

Improve documentation

  • Log In
  • Views
    • XML
    • Word
    • Printable

Details

  • Type: Improvement Improvement
  • Status: Resolved Resolved
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 2.2
  • Fix Version/s: 2.3
  • Component/s: Documentation
  • Labels:
    None

Description

Posted by Gerard Meszaros on wiki:

There seems to be a large gap between the Two-Minute Tutorial and the detailed technical documentation (JavaDoc). This gap created a lot of frustration. Each of the following issues may, for all we know, have good solutions in the product. We just couldn't find them! The Two-Minute Tutorial seemed to leave out a bunch of important stuff. We couldn't get the example to actually compile and run until we discovered this. The installation information was non-existant/incomlete. There was no mention of the need to have hamcrest-all-1.2.jar installed so we couldn't code the equalTo in the ensureThat. The use of Static Imports to allow these methods be referenced without class names on front should be highlighted in the example.

The link to the examples (which we are encouraged to review) is broken.

When running scenarios with Pending steps, the tests still run green. The documentation does say this can be changed but we were unsuccessful at doing it. It seems to be rather involved and/or voodoo. It would be good to have a very clear description of 1) Why it considers Pending steps as green and 2) how to cause the pending steps to fail the tests in various environments (e.g. Eclipse/Java)

Activity

  • All
  • Comments
  • Work Log
  • History
  • Activity
Hide
Permalink
Mauro Talevi added a comment - 05/Oct/09 4:42 AM

Addressed issues in the reference documentation guide: http://jbehave.org/reference/latest

Show
Mauro Talevi added a comment - 05/Oct/09 4:42 AM Addressed issues in the reference documentation guide: http://jbehave.org/reference/latest

People

  • Assignee:
    Mauro Talevi
    Reporter:
    Mauro Talevi
Vote (0)
Watch (0)

Dates

  • Created:
    03/Sep/09 2:44 AM
    Updated:
    10/Oct/09 3:50 AM
    Resolved:
    05/Oct/09 4:42 AM
  • Atlassian JIRA (v5.0.4#731-sha1:3aa7374)
  • Report a problem
  • Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.