Skip to content

Commit

Permalink
Improve/add module docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
hmpf committed Nov 10, 2023
1 parent 5841bf0 commit 3ceacf5
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 7 deletions.
2 changes: 0 additions & 2 deletions python/nav/web/auth/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
#
"""
Contains web authentication and login functionality for NAV.
The "*Middleware" is Django-specific.
"""

from datetime import datetime
Expand Down
3 changes: 3 additions & 0 deletions python/nav/web/auth/middleware.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
# more details. You should have received a copy of the GNU General Public
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
#
"""
Django middleware for handling login, authentication and authorization for NAV.
"""

import logging
import os
Expand Down
4 changes: 3 additions & 1 deletion python/nav/web/auth/remote_user.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
# more details. You should have received a copy of the GNU General Public
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
#

"""
Support logging in by having the web server set the REMOTE_USER header.
"""
import logging
from os.path import join

Expand Down
4 changes: 1 addition & 3 deletions python/nav/web/auth/sudo.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
#
"""
Contains web authentication and login functionality for NAV.
The "*Middleware" is Django-specific.
Sudo functionality for web authentication in NAV.
"""

import logging
Expand Down
5 changes: 4 additions & 1 deletion python/nav/web/auth/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
# more details. You should have received a copy of the GNU General Public
# License along with NAV. If not, see <http://www.gnu.org/licenses/>.
#

"""
Utilities for authentication/authorization in NAV that is independent of
login method.
"""
import logging

from django.conf import settings
Expand Down

0 comments on commit 3ceacf5

Please sign in to comment.