Skip to content

Commit 3ceacf5

Browse files
committed
Improve/add module docstrings
1 parent 5841bf0 commit 3ceacf5

File tree

5 files changed

+11
-7
lines changed

5 files changed

+11
-7
lines changed

python/nav/web/auth/__init__.py

-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
#
1616
"""
1717
Contains web authentication and login functionality for NAV.
18-
19-
The "*Middleware" is Django-specific.
2018
"""
2119

2220
from datetime import datetime

python/nav/web/auth/middleware.py

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
# more details. You should have received a copy of the GNU General Public
1414
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
1515
#
16+
"""
17+
Django middleware for handling login, authentication and authorization for NAV.
18+
"""
1619

1720
import logging
1821
import os

python/nav/web/auth/remote_user.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
# more details. You should have received a copy of the GNU General Public
1414
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
1515
#
16-
16+
"""
17+
Support logging in by having the web server set the REMOTE_USER header.
18+
"""
1719
import logging
1820
from os.path import join
1921

python/nav/web/auth/sudo.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
1515
#
1616
"""
17-
Contains web authentication and login functionality for NAV.
18-
19-
The "*Middleware" is Django-specific.
17+
Sudo functionality for web authentication in NAV.
2018
"""
2119

2220
import logging

python/nav/web/auth/utils.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@
1313
# more details. You should have received a copy of the GNU General Public
1414
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
1515
#
16-
16+
"""
17+
Utilities for authentication/authorization in NAV that is independent of
18+
login method.
19+
"""
1720
import logging
1821

1922
from django.conf import settings

0 commit comments

Comments
 (0)