Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking issue for improvement course documentation and code comments #109

Open
3 of 5 tasks
rebelice opened this issue Mar 16, 2022 · 1 comment
Open
3 of 5 tasks
Assignees

Comments

@rebelice
Copy link
Collaborator

rebelice commented Mar 16, 2022

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

## Project
### Introduction

### Topic
#### Knowledge topic
#### Related code

### Exercises
### References

Chinese version

## Project
### 简介

### XX主题
#### 相关知识
#### 相关代码

### 练习
### 引用

The code comments layout

  • 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
     *       .....
     */ 
    }
    

TODO

@rebelice rebelice self-assigned this Mar 16, 2022
@pupillord
Copy link
Contributor

I have completed the improvement of project 3 #111

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants