# HG changeset patch
# User Pulkit Goyal <7895pulkit@gmail.com>
# Date 2020-12-08 11:11:13
# Node ID cb12658bf0e1269cd8bbc0a9eaaa319e516acd98
# Parent  012e25abc603e2d03841a86c519e80f09cb6fa09

scmutil: improve documentation of writereporequirements()

This makes it easier to understand the difference between `writerequires()`
and `writereporequirements()`.

Differential Revision: https://phab.mercurial-scm.org/D9568

diff --git a/mercurial/scmutil.py b/mercurial/scmutil.py
--- a/mercurial/scmutil.py
+++ b/mercurial/scmutil.py
@@ -1573,7 +1573,12 @@ def istreemanifest(repo):
 
 
 def writereporequirements(repo, requirements=None):
-    """ writes requirements for the repo to .hg/requires """
+    """writes requirements for the repo
+
+    Requirements are written to .hg/requires and .hg/store/requires based
+    on whether share-safe mode is enabled and which requirements are wdir
+    requirements and which are store requirements
+    """
     if requirements:
         repo.requirements = requirements
     wcreq, storereq = filterrequirements(repo.requirements)