소스 검색

Fix #22: add doc to Test::Rail::Parser about config filtering for plans

Also add doc about the plans option itself
George S. Baugh 10 년 전
부모
커밋
e1947f9551
1개의 변경된 파일6개의 추가작업 그리고 2개의 파일을 삭제
  1. 6 2
      lib/Test/Rail/Parser.pm

+ 6 - 2
lib/Test/Rail/Parser.pm

@@ -52,9 +52,13 @@ Get the TAP Parser ready to talk to TestRail, and register a bunch of callbacks
 
 =item B<browser> - OBJECT: Something like an LWP::UserAgent.  Useful for mocking with L<Test::LWP::UserAgent::TestRailMock>.
 
-=item B<run> - STRING (optional): name of desired run. Required if run_id not passed.
+=item B<run> - STRING (semi-optional): name of desired run. Required if run_id not passed.
 
-=item B<run_id> - INTEGER (optional): ID of desired run. Required if run not passed.
+=item B<run_id> - INTEGER (semi-optional): ID of desired run. Required if run not passed.
+
+=item B<plan> - STRING (semi-optional): Name of test plan to use, if your run provided is a child of said plan.  Only relevant when run_id not passed.
+
+=item B<configs> - ARRAYREF (optional): Configurations to filter runs in plan by.  Runs can have the same name, yet with differing configurations in a plan; this handles that odd case.
 
 =item B<project> - STRING (optional): name of project containing your desired run.  Required if project_id not passed.