Update docs for improvements to SMB URLs.

miketeo · Sep 5, 2020 · 39570a0 · 39570a0
1 parent 08b286b
commit 39570a0
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 7 deletions.
diff --git a/docs/doctrees/api/smb_SMBHandler.doctree b/docs/doctrees/api/smb_SMBHandler.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/html/_sources/api/smb_SMBHandler.txt b/docs/html/_sources/api/smb_SMBHandler.txt
@@ -6,8 +6,12 @@ The SMBHandler class provides support for "smb://" URLs in the `urllib2 <http://
 
 Notes
 -----
-* Note that you need to pass in a valid hostname or IP address for the host component of the URL.
-  Do not use the Windows/NetBIOS machine name for the host component.
+* The host component of the URL must be one of the following:
+
+  * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com
+  * An IP address. Example: 192.168.1.1
+  * A comma-separated string "<NBName>,<IP>" where *<NBName>* is the Windows/NetBIOS machine name for remote SMB service, and *<IP>* is the service's IP address. Example: MYSERVER,192.168.1.1
+
 * The first component of the path in the URL points to the name of the shared folder.
   Subsequent path components will point to the directory/folder of the file.
 * You can retrieve and upload files, but you cannot delete files/folders or create folders.

diff --git a/docs/html/api/smb_SMBHandler.html b/docs/html/api/smb_SMBHandler.html
@@ -97,8 +97,12 @@ <h1>SMbHandler Class<a class="headerlink" href="#smbhandler-class" title="Permal
 <div class="section" id="notes">
 <h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li>Note that you need to pass in a valid hostname or IP address for the host component of the URL.
-Do not use the Windows/NetBIOS machine name for the host component.</li>
+<li>The host component of the URL must be one of the following:<ul>
+<li>A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com</li>
+<li>An IP address. Example: 192.168.1.1</li>
+<li>A comma-separated string &#8220;&lt;NBName&gt;,&lt;IP&gt;&#8221; where <em>&lt;NBName&gt;</em> is the Windows/NetBIOS machine name for remote SMB service, and <em>&lt;IP&gt;</em> is the service&#8217;s IP address. Example: MYSERVER,192.168.1.1</li>
+</ul>
+</li>
 <li>The first component of the path in the URL points to the name of the shared folder.
 Subsequent path components will point to the directory/folder of the file.</li>
 <li>You can retrieve and upload files, but you cannot delete files/folders or create folders.

diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/sphinx/source/api/smb_SMBHandler.rst b/sphinx/source/api/smb_SMBHandler.rst
@@ -6,8 +6,12 @@ The SMBHandler class provides support for "smb://" URLs in the `urllib2 <http://
 
 Notes
 -----
-* Note that you need to pass in a valid hostname or IP address for the host component of the URL.
-  Do not use the Windows/NetBIOS machine name for the host component.
+* The host component of the URL must be one of the following:
+
+  * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com
+  * An IP address. Example: 192.168.1.1
+  * A comma-separated string "<NBName>,<IP>" where *<NBName>* is the Windows/NetBIOS machine name for remote SMB service, and *<IP>* is the service's IP address. Example: MYSERVER,192.168.1.1
+
 * The first component of the path in the URL points to the name of the shared folder.
   Subsequent path components will point to the directory/folder of the file.
 * You can retrieve and upload files, but you cannot delete files/folders or create folders.