You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue aims to address the lack of course documentation and code comments for TinySQL. We will start from this step to improve the user experience.
We'd better use /* Project 1: Your Code Here */ to identify where the user needs to fill in.
We'd better add detailed comments to help users, such as:
func MyFunc(a int, b int) (int, error) {
/* What does `MyFunc` need to do?
* explain parameters:
* a int: ....;
* b int: ....;
* explain return value:
* int: ....;
* error: ....;
* `MyFunc` may need to follow the steps:
* 1. xxxx;
* 2. xxxx;
* .....
* Some hints that might be useful:
* - you may need some structs
* - you may need to add some members for struct A
* - you need to implement 'FuncA' first
* - Be aware of concurrency issues
* .....
*/
}
This issue aims to address the lack of course documentation and code comments for
TinySQL
. We will start from this step to improve the user experience.The documentation layout
Chinese version
The code comments layout
/* Project 1: Your Code Here */
to identify where the user needs to fill in.TODO
The text was updated successfully, but these errors were encountered: