chore(doc): Add comments and derive attributes #60

malik672 · 2024-03-22T16:47:57Z

this is to solve the documentation issue and close issue #50 and

shuhuiluo

Do not base the doc changes on the big-decimal changes as it changes the behaviour of this SDK. The amount of comments is excessive especially in the addresses mod since most of the variables are self-explanatory.

shuhuiluo · 2024-03-22T17:10:25Z

src/lib.rs

+/// Contains commonly used items from the Uniswap SDK Core.
+///
+/// This module re-exports items that are commonly used together,
+/// making it easier to import them in other parts of your application.


These comments should be placed on the top of each module.

src/entities/mod.rs

shuhuiluo · 2024-03-22T17:13:59Z

src/entities/fractions/mod.rs

+/// This module contains functionality related to currency amounts in the context of fractions.
 pub mod currency_amount;
+/// This module contains functionality related to fractions, which are used for various calculations
+/// in the SDK.
 pub mod fraction;
+/// This module contains functionality related to percentages, which are used for expressing
+/// fractions in a more human-readable format.
 pub mod percent;
+/// This module contains functionality related to prices, which are used for calculating exchange
+/// rates and other financial metrics.


These comments are so AI that they are too general and don't provide much insight.

true, will still have to change them just wanted something to fill the comments

malik672 · 2024-03-23T06:08:53Z

Do not base the doc changes on the big-decimal changes as it changes the behaviour of this SDK. The amount of comments is excessive especially in the addresses mod since most of the variables are self-explanatory.

tbh I didn't do it myself, used phind to generate most of the comments

shuhuiluo

I don't mean to waste your time. But could you start a new PR and only add comments where the code is not self-explanatory?

malik672 · 2024-03-25T05:13:12Z

I don't mean to waste your time. But could you start a new PR and only add comments where the code is not self-explanatory

sure, point me to the parts

shuhuiluo · 2024-03-25T05:51:25Z

I don't mean to waste your time. But could you start a new PR and only add comments where the code is not self-explanatory

sure, point me to the parts

Use your judgement. Break down the changes.

shuhuiluo

As I said, start a new PR and only add comments where the code isn't self-explanatory. Do not fill the code with useless AI comments to reduce readability. Move the hash map change to a different PR.

malik672 · 2024-04-14T07:41:52Z

As I said, start a new PR and only add comments where the code isn't self-explanatory. Do not fill the code with useless AI comments to reduce readability. Move the hash map change to a different PR.

yeah true, but there would have to be documentation though even for the self explanatory ones(from alloy) and can it not just be possible to just do both in one pr and maybe just change the title

shuhuiluo · 2024-04-14T07:58:31Z

As I said, start a new PR and only add comments where the code isn't self-explanatory. Do not fill the code with useless AI comments to reduce readability. Move the hash map change to a different PR.

yeah true, but there would have to be documentation though even for the self explanatory ones(from alloy) and can it not just be possible to just do both in one pr and maybe just change the title

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests

src/addresses.rs

src/chains.rs

src/constants.rs

src/entities/token.rs

src/error.rs

src/utils/mod.rs

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

src/error.rs

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

malik672 added 3 commits March 17, 2024 08:51

fix big-decimal issue

00963c9

fix big-decimal issue

78b5e9d

docs and example

12aab8d

malik672 requested a review from shuhuiluo March 22, 2024 16:48

resolving conflicts

1f7cff7

shuhuiluo requested changes Mar 22, 2024

View reviewed changes

malik672 added 2 commits March 24, 2024 19:23

changes

c849dd7

changes

30d2626

malik672 requested a review from shuhuiluo March 24, 2024 18:25

shuhuiluo requested changes Mar 24, 2024

View reviewed changes

malik672 added 3 commits April 12, 2024 18:38

fixes

59ed573

change hash table

d05ac13

change hash table

9a8c5ef

malik672 requested a review from shuhuiluo April 13, 2024 13:07

malik672 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 13, 2024

This was linked to issues Apr 13, 2024

Enhance documentation, add doctest #42

Closed

Use a faster HashMap crate #62

Closed

shuhuiluo requested changes Apr 13, 2024

View reviewed changes

malik672 added 5 commits April 17, 2024 02:40

changes to doc

8500a53

fixed documentations and refactored some documentations

29dc0cb

fixed documentations and refactored some documentations

92f72ad

fixed documentations and refactored some documentations

7699f8f

fixed documentations and refactored some documentations

754234d

malik672 requested a review from shuhuiluo April 17, 2024 14:13

fixed documentations and refactored some documentations

06096b8

shuhuiluo requested changes Apr 21, 2024

View reviewed changes

shuhuiluo changed the title ~~Docs~~ chore(doc): Add comments and derive attributes Apr 21, 2024

malik672 and others added 17 commits April 22, 2024 22:08

Update src/addresses.rs

d163b07

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/chains.rs

49aa01b

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/error.rs

1e3fbc0

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/utils/mod.rs

79fa3b5

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/token.rs

8489781

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/token.rs

31a02ad

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/constants.rs

d82133a

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/chains.rs

ff29c04

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update addresses.rs

2e89764

Update error.rs

ade88e8

Update src/entities/token.rs

6c853c1

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/constants.rs

98dd213

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/base_currency.rs

cc70c0e

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/fractions/fraction.rs

858ed40

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/fractions/fraction.rs

8397c17

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/fractions/fraction.rs

8b286f1

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

Update src/entities/currency.rs

02e56aa

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

shuhuiluo requested changes Apr 28, 2024

View reviewed changes

src/error.rs Outdated Show resolved Hide resolved

Update src/error.rs

faf864d

Co-authored-by: Shuhui Luo <107524008+shuhuiluo@users.noreply.github.com>

malik672 requested a review from shuhuiluo April 28, 2024 07:44

shuhuiluo approved these changes Apr 28, 2024

View reviewed changes

shuhuiluo merged commit 6c050a0 into master Apr 28, 2024
1 of 2 checks passed

shuhuiluo deleted the docs branch April 28, 2024 08:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(doc): Add comments and derive attributes #60

chore(doc): Add comments and derive attributes #60

malik672 commented Mar 22, 2024

shuhuiluo left a comment

shuhuiluo Mar 22, 2024

shuhuiluo Mar 22, 2024

malik672 Mar 23, 2024 •

edited

malik672 commented Mar 23, 2024

shuhuiluo left a comment

malik672 commented Mar 25, 2024

shuhuiluo commented Mar 25, 2024

shuhuiluo left a comment

malik672 commented Apr 14, 2024 •

edited

shuhuiluo commented Apr 14, 2024

chore(doc): Add comments and derive attributes #60

chore(doc): Add comments and derive attributes #60

Conversation

malik672 commented Mar 22, 2024

shuhuiluo left a comment

Choose a reason for hiding this comment

shuhuiluo Mar 22, 2024

Choose a reason for hiding this comment

shuhuiluo Mar 22, 2024

Choose a reason for hiding this comment

malik672 Mar 23, 2024 • edited

Choose a reason for hiding this comment

malik672 commented Mar 23, 2024

shuhuiluo left a comment

Choose a reason for hiding this comment

malik672 commented Mar 25, 2024

shuhuiluo commented Mar 25, 2024

shuhuiluo left a comment

Choose a reason for hiding this comment

malik672 commented Apr 14, 2024 • edited

shuhuiluo commented Apr 14, 2024

malik672 Mar 23, 2024 •

edited

malik672 commented Apr 14, 2024 •

edited