Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Commit b6a675c

Browse files
committed
add additional rdoc example for ordering
1 parent 252af8c commit b6a675c

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

lib/rspec/core/configuration.rb

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1389,8 +1389,12 @@ def self.delegate_to_ordering_manager(*methods)
13891389

13901390
# @macro delegate_to_ordering_manager
13911391
#
1392-
# Sets the default global order and, if order is `'rand:<seed>'`, also
1393-
# sets the seed.
1392+
# Sets the default global ordering strategy. By default this can be one
1393+
# of `:defined`, `:random`, but is customizable through the
1394+
# `register_ordering` API. If order is set to `'rand:<seed>'`,
1395+
# the seed will also be set.
1396+
#
1397+
# @see #register_ordering
13941398
delegate_to_ordering_manager :order=
13951399

13961400
# @macro delegate_to_ordering_manager
@@ -1412,13 +1416,32 @@ def self.delegate_to_ordering_manager(*methods)
14121416
# end
14131417
# end
14141418
#
1415-
# describe MyClass, :order => :reverse do
1419+
# RSpec.describe 'MyClass', :order => :reverse do
14161420
# # ...
14171421
# end
14181422
#
14191423
# @note Pass the symbol `:global` to set the ordering strategy that
14201424
# will be used to order the top-level example groups and any example
14211425
# groups that do not have declared `:order` metadata.
1426+
#
1427+
# @example
1428+
# RSpec.configure do |rspec|
1429+
# rspec.register_ordering :global do |examples|
1430+
# acceptance, other = examples.partition do |example|
1431+
# example.metadata[:type] == :acceptance
1432+
# end
1433+
# other + acceptance
1434+
# end
1435+
# end
1436+
#
1437+
# RSpec.describe 'MyClass', :type => :acceptance do
1438+
# # will run last
1439+
# end
1440+
#
1441+
# RSpec.describe 'MyClass' do
1442+
# # will run first
1443+
# end
1444+
#
14221445
delegate_to_ordering_manager :register_ordering
14231446

14241447
# @private

0 commit comments

Comments
 (0)