Comments (2)
You may have noticed that the code is well commented. With the start of SWOC, there are many classes added, but are not documented well. You just need to understand the functionality of class and static methods, and write 'code comments' above them.
For example:
/// Activity Add and Edit Sheet Screen widget.
///
/// Input form to create update and delete [Activity]
class ActivityEditSheet extends StatefulWidget {
/// Adds mock data for [Activity]s in the, `Hive box` (For testing purpose only)
///
/// If you think it as relational database,
/// It populates the [activityBoxName] Table by creating new rows
/// for each [Activity] of mock data if [activityBoxName] Table is empty
static Future<void> initialize() async {
Map<String, Activity> existingActivities = readAll();
if (existingActivities.isEmpty) {
mActivityList.forEach((Activity activity) async {
await create(activity);
});
}
}
I have talked to @Imadarshsri before you for this issue. But considering 'comment-first' rule of SWOC, I'm assigning this to you.
Note: please follow the documentation guide: https://dart.dev/guides/language/effective-dart/documentation
from star_book.
assign me this issue, i want to work on this
from star_book.
Related Issues (20)
- Change Project Issue link HOT 2
- Help Needed Documentation HOT 5
- Change link in Readme.md HOT 3
- Create Pull Request Template HOT 1
- [Bug] Intro Screen HOT 1
- Lock Orientation to Portrait HOT 3
- Create Journal Validation HOT 4
- [Bug] Clear Database HOT 3
- [Bug] App Name HOT 7
- Bug Fix Firebase Crashlytics
- Setup Injector for Firebase
- AI Journaling Insights HOT 2
- Don't force adding of title and notes HOT 3
- Add steps, How to run and deploy the project
- Add App Encryption Documentation in info.plist
- Add steps to create git tag and github release
- Replace URL in CONTRIBUTING.md HOT 1
- Add download on android button in readme HOT 16
- Discord link in PR template is invalid HOT 3
- Add buy me a coffee button
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from star_book.