Update ROADMAP.rst

Author: mjherzog

ROADMAP.rst

@@ -7,10 +7,10 @@ Top Issues
 1. Primary license detection, top issue.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-There is too much cruft in detected licenses, and we know too much without being
+There is too much cruft in detected licenses. We know too much without being
 to distinguish the forest from the trees. Therefore reporting the primary
-license detection is important: when we get SC results, we can often
-get 30 license on a single a package and that's a problem.
+license detection is important: when we get Scan results, we can often
+get 30 license for a single a package and that's a problem.
 It would make the logic of selection the primary license visible
 
 Is this for SCIO or SCTK? Likely a bit a both.
@@ -19,8 +19,8 @@ Is this for SCIO or SCTK? Likely a bit a both.
 2. Package files.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Reporting the set of package files for each package instance is important as
-it allows to naturally group these together in one unit.
+Reporting the set of package files for each package instance is important because
+it allows for natural grouping of these in one unit.
 
 
 3. Go to two-level reporting of detections to provide more effective detections
@@ -34,12 +34,12 @@ it allows to naturally group these together in one unit.
 
 *License*:
 
-- many detections in a file at different location, could be merged in a single reported license
+- many detections in a file at different locations, could be merged into a single reported license
 - same for primary licenses
 
 *Copyright*:
 
-- Copyrights and authors detection, which are tracked at the line level
+- Copyright and author detection, which are tracked at the line level
 - Holder would be for many copyright detections
 
 
@@ -60,50 +60,47 @@ Roadmap
   package-type/ecosystem conventions.
 - SCIO: add primary license field in DiscoveredPackage models and feed it with
   the data from packages
-- SCIO: Do we track secondary? or is this just aggregated data on the fly.
+- SCIO: Do we track secondary? or is this just data aggregated on the fly.
 - SCIO: Refine primary license based on license in "key files"  
 
 
 2. Primary copyright detection for packages
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- this is likely closely tied to the primary license detection and should focus
+- This is closely tied to the primary license detection and should focus
   on package manifests and key files. And on package first
 
 
-
 3. Package files
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - SCTK: See https://github.com/nexB/scancode-toolkit/projects/10
-  - work on the model
-  - work on updating the package code focus in npm, pypi, maven, go.
+  - Work on the model
+  - Work on updating the package code focus in npm, pypi, maven, go.
 - SCIO: adopt the two levels manifests/package instances
 
 
-
-4. Go to two-level reporting of detections for licenses
+4. Go to two-level reporting for license detections
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- add top level reference licenses section in the JSON output
-- report detections at the file level, one per matched rule
-- multiple detections for one or more license expressions in a file, eventually
+- Add top level reference licenses section in the JSON output
+- Report detections at the file level, one per matched rule
+- Report multiple detections for one or more license expressions in a file, eventually
   grouping multiple detection in a single expression in a file
 
 
-5. Go to two-level reporting of detections for holders
+5. Go to two-level reporting for copyright holder detections
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Reported detections of Copyrights and authors detection, tracked at the line level in a file
 - Holder would be for many copyright detections
 
 
-
 6. License detection quality improvements
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Finish and merge unknown license detection (this depends on having 4. Go to two-level reporting of detections for licenses done)
-- Update scancode-analyze to the new  two-level reporting of license detections
+- Finish and merge unknown license detection (this depends on completion of 4. Go to two-level reporting of detections for license)
+- Update scancode-analyze to the new two-level reporting of license detections
 - Revamp how common list of suprrious licenses are detected (this is a bug)
 - Use important key phrases for license detection https://github.com/nexB/scancode-toolkit/issues/2637