Patchwork D1016: repoview: remove incorrect documentation of the function

login
register
mail settings
Submitter phabricator
Date Oct. 11, 2017, 9:44 p.m.
Message ID <differential-rev-PHID-DREV-u5mxro6glqpx7tvolgiy-req@phab.mercurial-scm.org>
Download mbox | patch
Permalink /patch/24761/
State Superseded
Headers show

Comments

phabricator - Oct. 11, 2017, 9:44 p.m.
pulkit created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REVISION SUMMARY
  In repoview.py, computeunserved() and computemutable() functions had the same
  documentation. The documentation of computemutable() is wrong. I was unable to
  write documentation for the function but it's better to not having the
  documentation than having it wrong.

REPOSITORY
  rHG Mercurial

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

AFFECTED FILES
  mercurial/repoview.py

CHANGE DETAILS




To: pulkit, #hg-reviewers
Cc: mercurial-devel
phabricator - Oct. 12, 2017, 7:20 a.m.
dlax added inline comments.

INLINE COMMENTS

> repoview.py:104
> -
> -    Secret and hidden changeset should not pretend to be here."""
>      assert not repo.changelog.filteredrevs

Maybe update the docstring instead of removing?

REPOSITORY
  rHG Mercurial

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

To: pulkit, #hg-reviewers
Cc: dlax, mercurial-devel
phabricator - Oct. 12, 2017, 11:27 a.m.
ryanmce requested changes to this revision.
ryanmce added a comment.
This revision now requires changes to proceed.


  I agree that removing is better than leaving bad docs, so I'm +1 on this, but as @dlax suggests, improving it would be even better.
  
  If you don't have ideas on how to improve it, feel free to re-request review and I can queue this.

REPOSITORY
  rHG Mercurial

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

To: pulkit, #hg-reviewers, ryanmce
Cc: ryanmce, dlax, mercurial-devel
phabricator - Oct. 12, 2017, 5:24 p.m.
pulkit requested review of this revision.
pulkit added a comment.


  In https://phab.mercurial-scm.org/D1016#17086, @ryanmce wrote:
  
  > I agree that removing is better than leaving bad docs, so I'm +1 on this, but as @dlax suggests, improving it would be even better.
  >
  > If you don't have ideas on how to improve it, feel free to re-request review and I can queue this.
  
  
  I also agree with @dlax but unfortunately I don't have much ideas with this. Sorry. (re-requesting review)

INLINE COMMENTS

> dlax wrote in repoview.py:104
> Maybe update the docstring instead of removing?

I am not much confident about whether I understand this part of code correctly or not. So it was hard for me updating the doc.

REPOSITORY
  rHG Mercurial

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

To: pulkit, #hg-reviewers, ryanmce
Cc: ryanmce, dlax, mercurial-devel
phabricator - Oct. 13, 2017, 2:28 p.m.
ryanmce added a comment.


  queued

REPOSITORY
  rHG Mercurial

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

To: pulkit, #hg-reviewers, ryanmce
Cc: ryanmce, dlax, mercurial-devel

Patch

diff --git a/mercurial/repoview.py b/mercurial/repoview.py
--- a/mercurial/repoview.py
+++ b/mercurial/repoview.py
@@ -99,9 +99,6 @@ 
         return hiddens
 
 def computemutable(repo):
-    """compute the set of revision that should be filtered when used a server
-
-    Secret and hidden changeset should not pretend to be here."""
     assert not repo.changelog.filteredrevs
     # fast check to avoid revset call on huge repo
     if any(repo._phasecache.phaseroots[1:]):