From 5e0f12cc8f603c806135b489ae5cf1c233f82cea Mon Sep 17 00:00:00 2001 From: cowlinator Date: Thu, 9 Jul 2020 15:31:48 -0700 Subject: [PATCH] Corrected inaccuracies in boilerplate index.rst Virtual shebangs make the "linux-style" shebangs perfectly applicable to Windows (meaning they are not UNIX specific). See https://docs.python.org/3/using/windows.html#shebang-lines . Moved code snippets to be in script-order (they appear here in the order they would appear in a script). --- source/docs/boilerplate/index.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/source/docs/boilerplate/index.rst b/source/docs/boilerplate/index.rst index 3bc578a..9109ec1 100644 --- a/source/docs/boilerplate/index.rst +++ b/source/docs/boilerplate/index.rst @@ -2,15 +2,14 @@ Boilerplate =========== -`if __name__ == '__main__': main()`_ - Prevents main() from being executed during imports. `#!/usr/bin/env/python`_ - UNIX specific. + Searches the executable PATH for a Python executable. `#!/usr/local/bin/python`_ - UNIX specific. + For Python executables not managed by a distribution package manager. `#!/usr/bin/python`_ - UNIX specific. + The default Python will be located and used. `# -*- coding: utf-8 -*-`_ - Declares usage of UTF-8 characters in the script. + Declares usage of UTF-8 characters in the script. +`if __name__ == '__main__': main()`_ + Prevents main() from being executed during imports. - \ No newline at end of file