Page MenuHomeSoftware Heritage

crates: Add a developer documentation at module level
ClosedPublic

Authored by franckbret on Aug 8 2022, 10:17 AM.

Details

Summary

Mainly move documentation content from docs/user to crates module
(See D8199 for details)

Related T4104

Diff Detail

Repository
rDLS Listers
Branch
crates-doc
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 30670
Build 47957: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 47956: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D8206 (id=29605)

Rebasing onto a6f796b268...

Current branch diff-target is up to date.
Changes applied before test
commit 04f4dc3e27621563338c6df6092d54a90762c3bc
Author: Franck Bret <franck.bret@octobus.net>
Date:   Mon Aug 8 10:10:13 2022 +0200

    crates: Add a developer documentation at module level
    
    Mainly move documentation content from docs/user to crates module
    (See D8199 for details)
    
    Related T4104

See https://jenkins.softwareheritage.org/job/DLS/job/tests-on-diff/573/ for more details.

Module docstrings need to be the first statement of the file

Module docstrings need to be the first statement of the file

Build is green

Patch application report for D8206 (id=29623)

Rebasing onto a6f796b268...

Current branch diff-target is up to date.
Changes applied before test
commit 751c3df1b7aaf9ef126eb909a2fd0e9ed3f0a58f
Author: Franck Bret <franck.bret@octobus.net>
Date:   Mon Aug 8 10:10:13 2022 +0200

    crates: Add a developer documentation at module level
    
    Mainly move documentation content from docs/user to crates module
    (See D8199 for details)
    
    Related T4104

See https://jenkins.softwareheritage.org/job/DLS/job/tests-on-diff/574/ for more details.

This revision is now accepted and ready to land.Aug 8 2022, 3:05 PM