Skip to content

fix: README quickstart uses cd .. before entering repo - #3

Open
andrewwhitecdw wants to merge 1 commit into
NVIDIA-AI-IOT:masterfrom
andrewwhitecdw:bugfix/readme-readme-quickstart-uses-cd-before
Open

fix: README quickstart uses cd .. before entering repo#3
andrewwhitecdw wants to merge 1 commit into
NVIDIA-AI-IOT:masterfrom
andrewwhitecdw:bugfix/readme-readme-quickstart-uses-cd-before

Conversation

@andrewwhitecdw

Copy link
Copy Markdown

This PR corrects the documentation in README.md: README quickstart uses cd .. before entering repo.

Changes

  • README.md: README quickstart uses cd .. before entering repo.

Details

--- a/README.md
+++ b/README.md
@@ -1,2 +1,1 @@
-$ cd ..
-$ cd GreenMachine/src
+$ cd GreenMachine/src

Tests

  • tests/test_readme.py
diff --git a/tests/test_readme.py b/tests/test_readme.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/tests/test_readme.py
@@ -0,0 +1,33 @@
+import os
+import re
+import unittest
+
+README_PATH = os.path.join(os.path.dirname(__file__), '..', 'README.md')
+
+
+class TestReadmeCommands(unittest.TestCase):
+    def setUp(self):
+        with open(README_PATH) as f:
+            self.text = f.read()
+
+    def test_no_cd_up_before_entering_repo(self):
+        self.assertFalse(
+            '$ cd ..\n$ cd GreenMachine/src' in self.text,
+            'README tells users to cd .. before entering the cloned repo'
+        )
+        self.assertIn('$ cd GreenMachine/src', self.text)
+
+    def test_pip_uninstall_uses_package_name_not_wheel(self):
+        self.assertFalse(
+            re.search(r'\$ sudo pip uninstall tensorflow-[^\s]*\.whl', self.text),
+            'README uses the wheel filename for pip uninstall, which fails'
+        )
+        self.assertTrue(
+            re.search(r'\$ sudo pip uninstall tensorflow\b', self.text) is not None
+        )
+
+
+if __name__ == '__main__':
+    unittest.main()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant