Python: Improve documentation for moduleImport

tausbn · RasmusWL · web-flow · commit 56515c570879 · 2021-02-03T21:29:15.000+01:00
Co-authored-by: Rasmus Wriedt Larsen &lt;rasmuswriedtlarsen@gmail.com&gt;
diff --git a/python/ql/src/semmle/python/ApiGraphs.qll b/python/ql/src/semmle/python/ApiGraphs.qll
@@ -196,7 +196,13 @@ module API {
   /** Gets the root node. */
   Root root() { any() }
 
-  /** Gets a node corresponding to an import of module `m`. */
+  /** 
+   * Gets a node corresponding to an import of module `m`. 
+   *
+   * Note: You should only use this predicate for top level modules. If you want nodes corresponding to a submodule,
+   * you should use `.getMember` on the parent module. For example, for nodes corresponding to the module `foo.bar`, 
+   * use `moduleImport("foo").getMember("bar")`.
+   */
   Node moduleImport(string m) { result = Impl::MkModuleImport(m) }
 
   /**
