extend the documentation of SetPackagePath

gap-system · Jan 28, 2025 · 80712f2 · 80712f2
1 parent c026978
commit 80712f2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/package.gd b/lib/package.gd
@@ -910,6 +910,12 @@ DeclareGlobalFunction( "LoadAllPackages" );
 ##  contained in the <F>PackageInfo.g</F> file at <A>pkgpath</A> instead,
 ##  such that only the version installed at <A>pkgpath</A> can be loaded
 ##  with <Ref Func="LoadPackage"/>.
+##  <P/>
+##  One should call <Ref Func="SetPackagePath"/> immediately before loading
+##  the package in question.
+##  Note that calling <Ref Func="ExtendPackageDirectories"/> or
+##  <Ref Func="ExtendRootDirectories"/> may change the available versions
+##  of the package <A>pkgname</A>.
 ##  </Description>
 ##  </ManSection>
 ##  <#/GAPDoc>