Skip to content

Web3Auth Initial documentation#673

Merged
RyRy79261 merged 7 commits into
mainfrom
ryan/web3auth-documentation-671
Oct 30, 2023
Merged

Web3Auth Initial documentation#673
RyRy79261 merged 7 commits into
mainfrom
ryan/web3auth-documentation-671

Conversation

@RyRy79261
Copy link
Copy Markdown
Contributor

@RyRy79261 RyRy79261 commented Oct 19, 2023

closes #671

@RyRy79261 RyRy79261 self-assigned this Oct 19, 2023
@RyRy79261 RyRy79261 marked this pull request as ready for review October 20, 2023 13:29
kalambet
kalambet requested changes Oct 23, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@kalambet kalambet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not necessary to document body of the tests (no need to remove what is already there, though) but it does make sense to document bodies of the SetUp and TearDown functions more where it is necessary.
There are more tests files that are missing in this PR.

@RyRy79261
Copy link
Copy Markdown
Contributor Author

RyRy79261 commented Oct 23, 2023

@kalambet So the test files I was pointed at were only these ones, as for any other test files, I'm not sure they're within this scope

@kalambet
Copy link
Copy Markdown
Member

kalambet commented Oct 24, 2023

@RyRy79261 what I meant is that in the ChainSafe.Tests project contains beside ProvidersSendTests.cs that you updated also:

ChainlinkLootboxTests.cs
ChainsafeRPCTests.cs
Web3Util.cs

sneakzttv
sneakzttv approved these changes Oct 25, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@sneakzttv sneakzttv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

everything else looks great

@RyRy79261
Copy link
Copy Markdown
Contributor Author

RyRy79261 commented Oct 25, 2023

@kalambet

that in the ChainSafe.Tests project contains beside ProvidersSendTests.cs that you updated also:

What did you mean by this?

@kalambet
Copy link
Copy Markdown
Member

kalambet commented Oct 25, 2023

I mean that this is the current set of your changes:
image

But Test project has 3 more files:

ChainlinkLootboxTests.cs
ChainsafeRPCTests.cs
Web3Util.cs

That needs docstrings.

@RyRy79261 RyRy79261 requested a review from kalambet October 26, 2023 11:18
kalambet
kalambet approved these changes Oct 26, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@kalambet kalambet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@RyRy79261 RyRy79261 merged commit b1d8edf into main Oct 30, 2023
@RyRy79261 RyRy79261 deleted the ryan/web3auth-documentation-671 branch October 30, 2023 11:56
robGG1997 pushed a commit that referenced this pull request Nov 3, 2023
@RyRy79261 @robGG1997
Web3Auth Initial documentation (#673)
4a75425 
* Initial docs added

* Set up tests commented

* Added comments

* Lootbox documentation
rob1997 pushed a commit that referenced this pull request Jan 16, 2025
@RyRy79261 @rob1997
Web3Auth Initial documentation (#673)
6f1c889 
* Initial docs added

* Set up tests commented

* Added comments

* Lootbox documentation
sergeypanin1994 pushed a commit to sergeypanin1994/web3.unity that referenced this pull request Mar 16, 2025
@RyRy79261
Web3Auth Initial documentation (ChainSafe#673)
9d3d23b 
* Initial docs added

* Set up tests commented

* Added comments

* Lootbox documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kalambet kalambet kalambet approved these changes

@juans-chainsafe juans-chainsafe Awaiting requested review from juans-chainsafe

@kantagara kantagara Awaiting requested review from kantagara

@oleksandrchainsafe oleksandrchainsafe Awaiting requested review from oleksandrchainsafe

+2 more reviewers

@sneakzttv sneakzttv sneakzttv approved these changes

@robGG1997 robGG1997 robGG1997 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@RyRy79261 RyRy79261

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create Documentation for Web3Auth Package in Unity, and the tests (SetUp method mostly) that we have created for our Web3 package.

4 participants

@RyRy79261 @kalambet @sneakzttv @robGG1997