Skip to content

Allow to use short example definition #503

Description

@artofhuman

This is an enhancement request.

Proposal:
Allow to use example in two ways

  1. Test case without description. Such tests should not be rendered in documentation.
example do
   do_request
   # ...
end

It should allow writing tests cases without noisy document: false. Also, tests wrote with using rspec it should not be passed to documentation without description

it do
  do_request
  #...
end
  1. Add :nodoc according document: false.
example "get items", :nodoc do
   do_request
   # ...
end

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions