Details
- Reviewers
zack - Group Reviewers
Reviewers - Commits
- rDTSCN2fb9cb1c59e2: docs: readme and cli description update
Diff Detail
- Repository
- rDTSCN Code scanner
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
Event Timeline
Build is green
Patch application report for D3876 (id=13671)
Rebasing onto d4f9b2d6d6...
Current branch diff-target is up to date.
Changes applied before test
commit 1353b53baebb2bb4c4f8fd991d8eb8a6031a9473
Author: Daniele Serafini <me@danieleserafini.eu>
Date: Thu Sep 3 16:01:15 2020 +0200
readme and cli description updateSee https://jenkins.softwareheritage.org/job/DTSCN/job/tests-on-diff/37/ for more details.
| docs/README.rst | ||
|---|---|---|
| 0 | This is fine, but maintaining here a duplication of the auto-generated --help message is not a great idea (it violates the DRY principle and all that). Instead of this, I suggest doing what we did for the swh-model CLI documentation, which is generated using Sphinx/Click integration. | |
| swh/scanner/cli.py | ||
| 73–74 | Just the other day I was trying to use this, and couldn't. This help string needs a description of pattern semantics and/or an example of a concrete pattern to help users. (And I also think it would be a good idea to exclude stuff like ".git" by default, but that is material for a separate diff.) | |
| swh/scanner/cli.py | ||
|---|---|---|
| 73–74 | I think we should also mention that the patterns are translated into regex objects by fnmatch that uses shell-style wildcards. | |
Build is green
Patch application report for D3876 (id=13741)
Rebasing onto d4f9b2d6d6...
Current branch diff-target is up to date.
Changes applied before test
commit d4e6c2601cb7cf336112027e09a3a4ef0798a35a
Author: Daniele Serafini <me@danieleserafini.eu>
Date: Wed Sep 9 17:39:47 2020 +0200
docs: readme and cli description updateSee https://jenkins.softwareheritage.org/job/DTSCN/job/tests-on-diff/38/ for more details.
| README.md | ||
|---|---|---|
| 4–5 | I've changed this in swh-docs index as follows: "source code scanner to analyze code bases and compare them with source code artifacts archived by Software Heritage" can you use the same text here? | |
| setup.py | ||
| 45 | as you are switching from .rst to .md (which is fine!), you should also change this to: long_description_content_type="text/markdown", | |
| setup.py | ||
|---|---|---|
| 45 | oh, i missed that, thanks! | |
Build is green
Patch application report for D3876 (id=13786)
Rebasing onto d4f9b2d6d6...
Current branch diff-target is up to date.
Changes applied before test
commit ed5cd7f64472e69a8c95216d87712b8ea6078e5a
Author: Daniele Serafini <me@danieleserafini.eu>
Date: Wed Sep 9 17:39:47 2020 +0200
docs: readme and cli description updateSee https://jenkins.softwareheritage.org/job/DTSCN/job/tests-on-diff/41/ for more details.
Build is green
Patch application report for D3876 (id=13804)
Rebasing onto 9ce6ddc054...
Current branch diff-target is up to date.
Changes applied before test
commit 2fb9cb1c59e2afde3c03ee473fb8f230192082c3
Author: Daniele Serafini <me@danieleserafini.eu>
Date: Thu Sep 10 17:20:54 2020 +0200
docs: readme and cli description updateSee https://jenkins.softwareheritage.org/job/DTSCN/job/tests-on-diff/43/ for more details.