search

makerdao / auction-demo-keeper

Apache License 2.0
33 stars 19 forks source link

Explain main functions in readme #21

Closed njokuScript closed 3 years ago

njokuScript commented 3 years ago

I think you should not copy the comments from the files and paste them here. The reader can read them directly from the JS file if they want to understand the functions. What I think you should do is make an overview of the main functionality of each module and explain it in a paragraph so the reader gets the bigger picture. If the reader wants to know more, he then goes to the actual file and reads the functions and its comments.

I think you should not copy the comments from the files and paste them here. The reader can read them directly from the JS file if they want to understand the functions. What I think you should do is make an overview of the main functionality of each module and explain it in a paragraph so the reader gets the bigger picture. If the reader wants to know more, he then goes to the actual file and reads the functions and its comments.

Okay, got that.

liberuum commented 3 years ago

LGTM