Page MenuHomeSoftware Heritage

docs: Add section about Django components
ClosedPublic

Authored by anlambert on Apr 9 2021, 6:14 PM.

Details

Summary

Document the Django features implemented in swh-auth.

Diff Detail

Repository
rDAUTH Common authentication libraries
Branch
swh-auth-django-doc
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 20625
Build 32009: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 32008: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D5482 (id=19592)

Rebasing onto 70a8aec125...

Current branch diff-target is up to date.
Changes applied before test
commit fea65c647946a5db675292a63a50a26fbc13f8c9
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 9 16:28:32 2021 +0200

    docs: Add section about Django components

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

Missing new line at end of file

Build is green

Patch application report for D5482 (id=19593)

Rebasing onto 70a8aec125...

Current branch diff-target is up to date.
Changes applied before test
commit 746a71787debfb2effd92e9c1ada83cd2b3a1b1e
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 9 16:28:32 2021 +0200

    docs: Add section about Django components

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

Build is green

Patch application report for D5482 (id=19594)

Rebasing onto 70a8aec125...

Current branch diff-target is up to date.
Changes applied before test
commit 28f1d4da072386219a08d6411cde6438c3c34fb8
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 9 16:28:32 2021 +0200

    docs: Add section about Django components

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

LGTM, but some minor comments about the language

docs/django.rst
11–13

future tense -> present

a user -> users for indefinites

15–18

future tense -> present

"information" is uncountable and singular

24–31
43–46

either "user data" or "users' data"

57–59

future -> present

"its" -> "their" to refer to users

76–77
79–80

"User will then be able to" -> "Users can then" is more natural

"his" -> "their" to refer to unspecified users

108–109

flows better imo

Build is green

Patch application report for D5482 (id=19595)

Rebasing onto 70a8aec125...

Current branch diff-target is up to date.
Changes applied before test
commit 7fbb882c026693fcddcbba813703564018d7aeae
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 9 16:28:32 2021 +0200

    docs: Add section about Django components

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

vlorentz added inline comments.
docs/django.rst
24–31

forgot a change, "a Django applications"

This revision is now accepted and ready to land.Apr 9 2021, 6:56 PM

Build is green

Patch application report for D5482 (id=19596)

Rebasing onto 70a8aec125...

Current branch diff-target is up to date.
Changes applied before test
commit aeb7512e747b7deb88185e3c3796b21571e30192
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 9 16:28:32 2021 +0200

    docs: Add section about Django components

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