refactored and condensed technical documentation and comments across the codebase to improve readability

This commit is contained in:
2026-07-06 23:17:06 +02:00
parent c48f5ef215
commit a19b67eb84
27 changed files with 99 additions and 193 deletions
@@ -27,10 +27,9 @@ abstract class TimetableState with _$TimetableState {
required DateTime startDate,
required DateTime endDate,
@Default(0) int dataVersion,
// Boundaries learned from past server denials of inaccessible weeks.
// Inclusive: weeks whose start is on/before `accessibleEndDate` and
// whose end is on/after `accessibleStartDate` are within the user's
// permitted range. Null = no upper / lower bound discovered yet.
// Boundaries learned from past server denials. A week is permitted when its
// start is on/before `accessibleEndDate` and its end on/after
// `accessibleStartDate`. Null = that bound not discovered yet.
DateTime? accessibleStartDate,
DateTime? accessibleEndDate,
}) = _TimetableState;
@@ -23,10 +23,9 @@ import '../../../../../api/mhsl/custom_timetable_event/update/update_custom_time
import '../../../../../api/request_cache.dart';
import '../../../../../model/account_data.dart';
/// Pulls the timetable from the Marianum-Connect mobile API. Each MC endpoint
/// is its own HTTP call; this provider just exposes the lazy futures so the
/// bloc can chain them without seeing the dio layer. Custom events still come
/// from the MHSL backend and are unchanged.
/// Pulls the timetable from the Marianum-Connect mobile API. Each endpoint is
/// its own HTTP call; this provider exposes the lazy futures so the bloc can
/// chain them without seeing the dio layer. Custom events still come from MHSL.
class TimetableDataProvider {
Future<TimetableGetWeekResponse> getWeek(
DateTime startDate,