Patchwork D6170: perf: copyedit a few documentation strings

login
register
mail settings
Submitter phabricator
Date March 26, 2019, 2:21 p.m.
Message ID <differential-rev-PHID-DREV-alzecw3huzb6cvv6ya3e-req@phab.mercurial-scm.org>
Download mbox | patch
Permalink /patch/39385/
State Superseded
Headers show

Comments

phabricator - March 26, 2019, 2:21 p.m.
durin42 created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6170

AFFECTED FILES
  contrib/perf.py

CHANGE DETAILS




To: durin42, #hg-reviewers
Cc: mercurial-devel
phabricator - March 27, 2019, 10:28 a.m.
pulkit added a comment.


  Amending the following diff in flight because test-check-code.t was complaining.
  
    diff --git a/contrib/perf.py b/contrib/perf.py
    --- a/contrib/perf.py
    +++ b/contrib/perf.py
    @@ -26,7 +26,8 @@ Configurations
       The default value is: `3.0-100, 10.0-3`
     
     ``stub``
    -    When set, benchmarks will only be run once, useful for testing (default: off)
    +    When set, benchmarks will only be run once, useful for testing
    +    (default: off)
     '''
     
     # "historical portability" policy of perf.py:
  
  ( Looks like we found an issue with emacs thing for check-code )

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6170

To: durin42, #hg-reviewers, pulkit
Cc: mercurial-devel

Patch

diff --git a/contrib/perf.py b/contrib/perf.py
--- a/contrib/perf.py
+++ b/contrib/perf.py
@@ -8,25 +8,25 @@ 
 --------
 
 ``all-timing``
-    When set, additional statistic will be reported for each benchmark: best,
+    When set, additional statistics will be reported for each benchmark: best,
     worst, median average. If not set only the best timing is reported
     (default: off).
 
 ``presleep``
-  number of second to wait before any group of run (default: 1)
+  number of second to wait before any group of runs (default: 1)
 
 ``run-limits``
-  Control the number of run each benchmark will perform. The option value
+  Control the number of runs each benchmark will perform. The option value
   should be a list of `<time>-<numberofrun>` pairs. After each run the
-  condition are considered in order with the following logic:
-
-      If benchmark have been running for <time> seconds, and we have performed
+  conditions are considered in order with the following logic:
+
+      If benchmark has been running for <time> seconds, and we have performed
       <numberofrun> iterations, stop the benchmark,
 
   The default value is: `3.0-100, 10.0-3`
 
 ``stub``
-    When set, benchmark will only be run once, useful for testing (default: off)
+    When set, benchmarks will only be run once, useful for testing (default: off)
 '''
 
 # "historical portability" policy of perf.py:
@@ -1217,8 +1217,8 @@ 
 def perfparents(ui, repo, **opts):
     """benchmark the time necessary to fetch one changeset's parents.
 
-    The fetch is done using the `node identifier`, traversing all object layer
-    from the repository object. The N first revision will be used for this
+    The fetch is done using the `node identifier`, traversing all object layers
+    from the repository object. The first N revisions will be used for this
     benchmark. N is controlled by the ``perf.parentscount`` config option
     (default: 1000).
     """