changeset 52747:d13c2ae3c340

interfaces: add minor documentation to the `_basetypes` module This came up during the original review of this code. In short, the reason for the seeming redundancy is subtle, but valid.
author Matt Harbison <matt_harbison@yahoo.com>
date Thu, 06 Feb 2025 14:58:10 -0500
parents 4c99bb87891b
children fecda9f44e57
files mercurial/interfaces/_basetypes.py
diffstat 1 files changed, 5 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/interfaces/_basetypes.py	Fri Jan 31 20:32:32 2025 -0500
+++ b/mercurial/interfaces/_basetypes.py	Thu Feb 06 14:58:10 2025 -0500
@@ -3,10 +3,12 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 #
-# This module contains trivial type aliases that other interfaces might need.
-# This is for internal usage by the modules in `mercurial.interfaces`.
+# This module contains trivial type aliases that other interfaces might need,
+# in a location designed to avoid import cycles.  This is for internal usage
+# by the modules in `mercurial.interfaces`, instead of importing the `types`
+# module.
 #
-# For using type aliases outside for `mercurial.interfaces`, look at the
+# For using type aliases outside `mercurial.interfaces`, look at the
 # `mercurial.interfaces.types` module.
 
 from __future__ import annotations