solves issue 1287 : Created structure of the doc using sphinx by TG1999 · Pull Request #1550 · aboutcode-org/scancode-toolkit

TG1999 · 2019-05-07T19:18:28Z

I have used README.rst for making the doc. Solves #1287. Please review

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

Abhishek-Dev09-zz · 2019-05-07T19:25:55Z

Thanks, in this way you have to search issue and solve.

TG1999 · 2019-05-07T19:27:47Z

Here is a screenshot for the same

TG1999 · 2019-05-07T19:29:20Z

Thanks, @Abhishek-Dev09 for guiding

codecov · 2019-05-07T20:22:05Z

Codecov Report

Merging #1550 into develop will increase coverage by 0.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           develop   #1550      +/-   ##
==========================================
+ Coverage    84.32%   84.4%   +0.07%     
==========================================
  Files          124     124              
  Lines        14594   14594              
==========================================
+ Hits         12307   12318      +11     
+ Misses        2287    2276      -11

Impacted Files	Coverage Δ
src/scancode/api.py	`93.7% <0%> (-1.4%)`	⬇️
src/scancode/cli.py	`76.43% <0%> (+0.44%)`	⬆️
src/typecode/pygments_lexers.py	`52.9% <0%> (+0.64%)`	⬆️
src/commoncode/fileutils.py	`82.35% <0%> (+1.3%)`	⬆️
src/scancode/interrupt.py	`51.31% <0%> (+6.57%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 40e7192...de6a337. Read the comment docs.

TG1999 · 2019-05-08T01:19:34Z

Hi @Abhishek-Dev09 @pombredanne can you suggest me how to resolve this. I have not changed these files in my commit so I don't know how it affected the code coverage .

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

TG1999 · 2019-05-08T03:43:45Z

Now the code has passed all the checks, please review the changes
CC @pombredanne @Abhishek-Dev09

pombredanne · 2019-05-08T10:49:54Z

Thank you ++
Let me review this

pombredanne

Thank you! See my comments inline. Also read this https://github.com/nexB/aboutcode/wiki/Writing-good-commit-messages

pombredanne · 2019-05-08T10:54:34Z

src/scancode/api.py


            # FIXME: for sanity this should always be included?????
            if include_text:
+                matched_text = match.matched_text(whole_lines=False)


Can you remove this?

this is not about the documentation ticket Create basic documentation structure and tooling to build and publish #1287

even if you were to submit it separately this would not be accepted because the matched license text is something that is collected once for a match and not once for each license key in the match license expression, so your fix would make things go much much slower by recollecting the matched_text several times in the cases where there is more than one license in a detected rule

Can you remove that? Thanks!

pombredanne · 2019-05-08T10:55:48Z

docs/intro.rst

@@ -0,0 +1,194 @@
+================


I like this but there is a problem that it creates: we now have duplicated content in this intro and in the README.rst. that's likely a source of divergence and rework. What could you do instead to avoid this?

pombredanne · 2019-05-08T10:56:20Z

docs/conf.py

+
+# -- Project information -----------------------------------------------------
+
+project = 'AbutCode'


Here we are in the ScanCode toolkit subproject, not the top level AboutCode

pombredanne · 2019-05-08T10:57:50Z

docs/conf.py

+# -- Project information -----------------------------------------------------
+
+project = 'AbutCode'
+copyright = '2019, Tushar'


I appreciate that you push your copyright there, but I would prefer something more neutral such as " the ScanCode-toolkit authors and contributors or something like there is elsewhere in the code. You also need to ensure that this is detectable with ScanCode. Same for author below

pombredanne · 2019-05-08T10:58:36Z

docs/index.rst

@@ -0,0 +1,20 @@
+.. AbutCode documentation master file, created by


That would be ScanCode here and below

…to develop

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

TG1999 · 2019-05-08T15:28:11Z

@pombredanne I have made the changes as per your review.

Upsync the branch

pombredanne

Thank you. Your latest commits are missing the DCO signoff though... could you amend these?

pombredanne · 2019-05-13T14:52:11Z

src/scancode/api.py


            # FIXME: for sanity this should always be included?????
            if include_text:
+                matched_text = match.matched_text(whole_lines=False)


Can you remove that? Thanks!

pombredanne · 2019-05-13T14:55:03Z

@TG1999 also its looks like @DennisClark pushed the basic doc structure with this commit 415d0c8
Could you rebase and adapt/adopt @DennisClark structure?
Thanks!

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

steven-esser · 2019-07-10T03:03:00Z

@DennisClark Should this be moved to aboutcode? If so I will close and redirect the student to the proper location.

steven-esser · 2019-10-24T15:54:09Z

Changes to this have become stale.

basic document structure added using sphinx

d674356

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

trying to solve coverage issue

ed3a5fc

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

pombredanne requested changes May 8, 2019

View reviewed changes

TG1999 added 2 commits May 8, 2019 20:52

Merge branch 'develop' of https://github.com/nexB/scancode-toolkit in…

68b93bc

…to develop

add structure for the doc

a0b344f

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

TG1999 added 3 commits May 10, 2019 12:42

Delete make.bat

d6a6bef

Delete Makefile

3f963da

Merge pull request #1 from nexB/develop

952b722

Upsync the branch

pombredanne requested changes May 13, 2019

View reviewed changes

TG1999 added 4 commits May 16, 2019 20:59

resolving changes

da4a6bb

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

resolving changes

b93722e

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

resolving changes

672b33f

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

resolving changes

de6a337

Signed-off-by: TG1999 <tushar.goel.dav@gmail.com>

AyanSinhaMahapatra mentioned this pull request Oct 18, 2019

CLI Options Reference for v3.1.1 aboutcode-org/aboutcode#27

Merged

steven-esser closed this Oct 24, 2019


		# -- Project information -----------------------------------------------------

		project = 'AbutCode'

		@@ -0,0 +1,20 @@
		.. AbutCode documentation master file, created by

Uh oh!

Conversation

TG1999 commented May 7, 2019

Uh oh!

Abhishek-Dev09-zz commented May 7, 2019

Uh oh!

TG1999 commented May 7, 2019

Uh oh!

TG1999 commented May 7, 2019

Uh oh!

codecov bot commented May 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TG1999 commented May 8, 2019

Uh oh!

TG1999 commented May 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pombredanne commented May 8, 2019

Uh oh!

pombredanne left a comment

Choose a reason for hiding this comment

Uh oh!

pombredanne May 8, 2019

Choose a reason for hiding this comment

Uh oh!

pombredanne May 13, 2019

Choose a reason for hiding this comment

Uh oh!

pombredanne May 8, 2019

Choose a reason for hiding this comment

Uh oh!

pombredanne May 8, 2019

Choose a reason for hiding this comment

Uh oh!

pombredanne May 8, 2019

Choose a reason for hiding this comment

Uh oh!

pombredanne May 8, 2019

Choose a reason for hiding this comment

Uh oh!

TG1999 commented May 8, 2019

Uh oh!

pombredanne left a comment

Choose a reason for hiding this comment

Uh oh!

pombredanne May 13, 2019

Choose a reason for hiding this comment

Uh oh!

pombredanne commented May 13, 2019

Uh oh!

steven-esser commented Jul 10, 2019

Uh oh!

steven-esser commented Oct 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented May 7, 2019 •

edited

Loading

TG1999 commented May 8, 2019 •

edited

Loading

steven-esser commented Oct 24, 2019 •

edited

Loading