A platform, 'Traffic-Violation-Report-System', enabling users in Taiwan to upload and share responses from law enforcement to traffic violations. This system aims for greater transparency in traffic law enforcement. It utilises Django for backend and Flutter for a separated frontend web development.
GNU Affero General Public License v3.0
0
stars
0
forks
source link
[Sweep Rules] Add docstrings to functions and file headers #135
PR Feedback (click)
I created this PR to address this rule:
"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to functions and file headers in the following files:
lib/screens/accounts/social_connections_page.dart
lib/services/map_service.dart
lib/services/social_service.dart
The docstrings provide a brief description of the purpose of each function and class, as well as any parameters or return values they may have.
Summary of Changes
SocialConnectionsPage
class inlib/screens/accounts/social_connections_page.dart
.SocialConnectionsPageState
class inlib/screens/accounts/social_connections_page.dart
._disconnectSocialAccount
function inlib/screens/accounts/social_connections_page.dart
.build
function inlib/screens/accounts/social_connections_page.dart
._buildConnectedAccountItem
function inlib/screens/accounts/social_connections_page.dart
._buildProviderItem
function inlib/screens/accounts/social_connections_page.dart
.MapService
class inlib/services/map_service.dart
.loadMarkers
function inlib/services/map_service.dart
.getTrafficViolationDetails
function inlib/services/map_service.dart
.searchData
function inlib/services/map_service.dart
.SocialService
class inlib/services/social_service.dart
.getConnectedAccounts
function inlib/services/social_service.dart
.getAvailableProviders
function inlib/services/social_service.dart
.disconnectAccount
function inlib/services/social_service.dart
.connectWithProvider
function inlib/services/social_service.dart
.SocialProvider
class inlib/services/social_service.dart
.These changes improve code readability and maintainability by providing clear documentation for each function and class.