opentap / OpenTap.Python

Python integration for OpenTAP
Apache License 2.0
20 stars 6 forks source link

Remove stray documentation from v2.x #145

Closed g-galante closed 3 months ago

g-galante commented 9 months ago

Resolves #144

g-galante commented 9 months ago

Sorry, I hadn't noticed that it was added with Python 3.0 in commit 6d869575170d479614534e47154d01672eb9cc06.

However, similar information is also provided in: https://github.com/opentap/OpenTap.Python/blob/5355d7b01959f2c1235b90c8550c91be5e754c0a/Documentation/TAP_Python_Help/Getting_Started.md?plain=1#L25-L33

And the paths shown there are a good hint to where the files may be located, as opposed to: https://github.com/opentap/OpenTap.Python/blob/5355d7b01959f2c1235b90c8550c91be5e754c0a/Documentation/TAP_Python_Help/Virtual_Environments.md?plain=1#L1-L11 which is a little bit less informative, and contains a typo (set-library-path instead of set-lib-path).

So the two files may just be merged as follows:

diff --git a/Documentation/TAP_Python_Help/Getting_Started.md b/Documentation/TAP_Python_Help/Getting_Started.md
index 84724113..a5c892e7 100644
--- a/Documentation/TAP_Python_Help/Getting_Started.md
+++ b/Documentation/TAP_Python_Help/Getting_Started.md
@@ -22,7 +22,7 @@ On Ubuntu we recommend installing Python using apt.
 e.g 
 ```apt install python3.10```

-### Other Platforms and custom Python installations
+### Other Platforms and custom Python installations or Virtual Environments

 On other platforms we might not be able to detect the python installation. 
 In this case you can set the python library and installation path manually.
@@ -31,6 +31,7 @@ Here is an example of how this is done on a MacOS GitHub builds:
           ./bin/Debug/tap python set-path $Python3_ROOT_DIR
           ./bin/Debug/tap python set-lib-path $Python3_ROOT_DIR/lib/libpython3.10.dylib

+In case of virtual environments, the libpython library file should match the python version needed in your virtual environment, otherwise you might get strange results.

Create and Run a Simple Test Plan

To just run the 'Basic Functionality' step, you can create a test plan with the following components in the GUI:



If you don't like this solution, just let me know where [Documentation/TAP_Python_Help/Virtual_Environments.md](https://github.com/opentap/OpenTap.Python/blob/5355d7b01959f2c1235b90c8550c91be5e754c0a/Documentation/TAP_Python_Help/Virtual_Environments.md) should be inserted in: https://github.com/opentap/OpenTap.Python/blob/5355d7b01959f2c1235b90c8550c91be5e754c0a/Documentation/.vuepress/config.js#L15-L38 and I'll restore it, fix the typo, and reference it in the renamed [Documentation/TAP_Python_Help/Index.md](https://github.com/opentap/OpenTap.Python/blob/5355d7b01959f2c1235b90c8550c91be5e754c0a/Documentation/TAP_Python_Help/Index.md) as well.
g-galante commented 3 months ago

Closed because of Issue https://github.com/opentap/OpenTap.Python/issues/144#issuecomment-2124217212.