minor docs and comment updates

Author: jpstroop

docs/DEVELOPMENT.md

@@ -1,14 +1,14 @@
 # Conventions, Patterns, and Development Guide
 
-## Development Environment Setup
+## Set up Development Environment
 
 ### Prerequisites
 
 - Python 3.13+
 - PDM
 - Git
 
-### Initial Setup
+### Download and Install the Source Code
 
 1. Clone the repository:
 
@@ -206,7 +206,7 @@ Method aliases were implemented for several important reasons:
    direct aliases, developers can choose the approach that best fits their needs
    \- organization or conciseness.
 
-All method aliases are set up in the `_setup_method_aliases()` method in the
+All method aliases are set up in the `_set_up_method_aliases()` method in the
 [`FitbitClient`](fitbit_client/client.py) class, which is called during
 initialization. Each alias is a direct reference to the corresponding resource
 method, ensuring consistent behavior regardless of how the method is accessed.

fitbit_client/client.py

@@ -235,7 +235,7 @@ def __init__(
         self.logger.debug("Fitbit client initialized successfully")
 
         # Set up method aliases
-        self._setup_method_aliases()
+        self._set_up_method_aliases()
 
     def authenticate(self, force_new: bool = False) -> bool:
         """
@@ -268,7 +268,7 @@ def authenticate(self, force_new: bool = False) -> bool:
             self.logger.error(f"System error during authentication: {str(e)}")
             raise
 
-    def _setup_method_aliases(self) -> None:
+    def _set_up_method_aliases(self) -> None:
         """Set up direct access to resource methods as client attributes for convenience."""
         self.logger.debug("Setting up method aliases")
 

tests/auth/test_callback_server.py

@@ -79,14 +79,12 @@ def test_initialization_with_valid_uri(self):
 
     def test_create_handler(self, server):
         """Test the factory function for creating CallbackHandler instances"""
-        # Setup mock objects
         mock_request = MagicMock()
         mock_client_address = ("127.0.0.1", 1234)
         mock_server = MagicMock()
 
         # Patch the CallbackHandler to verify it gets instantiated correctly
         with patch("fitbit_client.auth.callback_server.CallbackHandler") as mock_handler_class:
-            # Setup the mock to return a mock instance
             mock_handler = MagicMock()
             mock_handler_class.return_value = mock_handler
 
@@ -361,7 +359,6 @@ def test_wait_for_callback_success(self, server):
     def test_stop_server_removes_temp_files(self, server):
         """Test that temporary files are cleaned up"""
         with patch("fitbit_client.auth.callback_server.unlink") as mock_unlink:
-            # Setup mock temp files
             server.cert_file = Mock()
             server.cert_file.name = "test_cert.pem"
             server.key_file = Mock()
@@ -383,7 +380,6 @@ def test_stop_server_handles_cleanup_errors(self, server):
         with patch(
             "fitbit_client.auth.callback_server.unlink", side_effect=Exception("Cleanup Error")
         ):
-            # Setup mock temp files
             server.cert_file = Mock()
             server.cert_file.name = "test_cert.pem"
             server.key_file = Mock()

tests/auth/test_oauth.py

@@ -191,7 +191,6 @@ def test_authenticate_force_new(self, oauth):
             "expires_at": time() + 3600,
         }
 
-        # Setup mocks
         oauth.is_authenticated = Mock(return_value=True)
         oauth.get_authorization_url = Mock(return_value=("test_url", "test_state"))
         oauth.fetch_token = Mock(return_value=mock_token)
@@ -215,7 +214,6 @@ def test_authenticate_uses_fetch_token_directly(self, oauth):
             "expires_at": time() + 3600,
         }
 
-        # Setup mocks
         oauth.get_authorization_url = Mock(return_value=("test_url", "test_state"))
         oauth.fetch_token = Mock(return_value=mock_token)
         oauth.is_authenticated = Mock(return_value=False)
@@ -356,7 +354,6 @@ def test_fetch_token_catches_oauth_errors(self, oauth):
         mock_session.fetch_token.side_effect = original_error
         oauth.session = mock_session
 
-        # Setup logger mock to capture log message
         mock_logger = Mock()
         oauth.logger = mock_logger
 
@@ -386,7 +383,6 @@ def test_fetch_token_no_matching_error_type(self, oauth):
         mock_session.fetch_token.side_effect = original_error
         oauth.session = mock_session
 
-        # Setup logger mock to capture log message
         mock_logger = Mock()
         oauth.logger = mock_logger
 
@@ -479,7 +475,6 @@ def test_refresh_token_wraps_unexpected_errors(self, oauth):
         mock_session.refresh_token.side_effect = unexpected_error
         oauth.session = mock_session
 
-        # Setup logger mock to capture log message
         mock_logger = Mock()
         oauth.logger = mock_logger
 
@@ -677,7 +672,6 @@ def test_is_authenticated_no_token(self, oauth):
 
     def test_is_authenticated_with_valid_token(self, oauth):
         """Test is_authenticated with a non-expired token"""
-        # Setup a valid token with future expiry
         future_time = time() + 3600  # 1 hour in the future
         oauth.token = {"access_token": "valid_token", "expires_at": future_time}
 
@@ -688,7 +682,6 @@ def test_is_authenticated_with_valid_token(self, oauth):
 
     def test_is_authenticated_with_expired_token(self, oauth):
         """Test is_authenticated with an expired token"""
-        # Setup an expired token
         past_time = time() - 3600  # 1 hour in the past
         oauth.token = {"access_token": "expired_token", "expires_at": past_time}
 

tests/resources/test_base.py

@@ -672,9 +672,7 @@ def test_make_direct_request_unexpected_content_type(mock_get_calling, base_reso
 @patch("fitbit_client.resources.base.BaseResource._get_retry_after")
 def test_direct_request_rate_limit_retry(mock_get_retry, mock_sleep, base_resource, mock_logger):
     """Test rate limit retry for direct requests."""
-    # This tests lines 691-693 in base.py
 
-    # Setup mock responses
     rate_limit_response = Mock()
     rate_limit_response.status_code = 429
     rate_limit_response.headers = {
@@ -1022,7 +1020,6 @@ def test_rate_limit_retry_with_fitbit_headers(
     mock_sleep, base_resource, mock_oauth_session, mock_logger
 ):
     """Test that rate limit retry correctly uses Fitbit headers for retry timing."""
-    # Setup mock responses
     rate_limit_response = Mock()
     rate_limit_response.status_code = 429
     rate_limit_response.headers = {