Differential D8206

crates: Add a developer documentation at module level
ClosedPublic
Actions

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

Details

Reviewers

vlorentz

Group Reviewers

Reviewers

Maniphest Tasks

T4104: Ingest crates.io (Rust)

Commits

rDLS751c3df1b7aa: crates: Add a developer documentation at module level

Summary

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

Related T4104

Diff Detail

Repository

rDLS Listers

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

franckbret created this revision.Aug 8 2022, 10:17 AM

Herald added a reviewer: Reviewers. · View Herald TranscriptAug 8 2022, 10:17 AM

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.

Harbormaster completed remote builds in B30670: Diff 29605.Aug 8 2022, 10:22 AM

franckbret requested review of this revision.Aug 8 2022, 10:22 AM

franckbret mentioned this in D8199: Add a 'user' documentation entry for the Crates lister. Add myself as contributor.Aug 8 2022, 10:24 AM

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.

Harbormaster completed remote builds in B30689: Diff 29623.Aug 8 2022, 2:54 PM

thanks!

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

Closed by commit rDLS751c3df1b7aa: crates: Add a developer documentation at module level (authored by franckbret). · Explain WhyAug 8 2022, 3:09 PM

This revision was automatically updated to reflect the committed changes.

franckbret added a commit: rDLS751c3df1b7aa: crates: Add a developer documentation at module level.

bchauvet added a task: T4104: Ingest crates.io (Rust).Sep 30 2022, 10:20 AM