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

Document the ethers object #4254

Closed
fulldecent opened this issue Jul 18, 2023 · 3 comments
Closed

Document the ethers object #4254

fulldecent opened this issue Jul 18, 2023 · 3 comments
Assignees
Labels
documentation Documentation related issue. fixed/complete This Bug is fixed or Enhancement is complete and published. v6 Issues regarding v6

Comments

@fulldecent
Copy link

Ethers Version

6.6.4

Search Terms

getDefaultProvider

Describe the Problem

On the published documentation, you cannot search for/see reference for the ethers object and its properties/methods.

Example

In 6.4.4 there is an ethers.getDefaultProvider function

Screenshot 2023-07-18 at 17 26 09

But the API documentation only documents one function .version.

Screenshot 2023-07-18 at 17 25 42

And the rest of the documentation makes no mention of getDefaultProvider:

Screenshot 2023-07-18 at 17 26 19

Code Snippet

No response

Contract ABI

No response

Errors

No response

Environment

No response

Environment (Other)

No response

@fulldecent fulldecent added investigate Under investigation and may be a bug. v6 Issues regarding v6 labels Jul 18, 2023
@ricmoo
Copy link
Member

ricmoo commented Jul 18, 2023

Interesting. I’ll look into why Flatworm didn’t rank the exact match highest, little lone not at all…

@ricmoo ricmoo added the next-patch Issues scheduled for the next arch release. label Aug 10, 2023
@ricmoo ricmoo added the documentation Documentation related issue. label Sep 11, 2023
@ricmoo
Copy link
Member

ricmoo commented Nov 1, 2023

I forgot to close this issue, but it was fixed.

The problem was Flatworm drops entries from the search with no body content, so since there was no docs provided for the method, it was dropped. I've added logging during documentation generation to complain in these cases and also added documentation to several functions and methods, that like getDefaultProvider, were lacking.

Thanks! :)

@ricmoo ricmoo closed this as completed Nov 1, 2023
@ricmoo ricmoo added fixed/complete This Bug is fixed or Enhancement is complete and published. and removed investigate Under investigation and may be a bug. next-patch Issues scheduled for the next arch release. labels Nov 1, 2023
@fulldecent
Copy link
Author

Cool, thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related issue. fixed/complete This Bug is fixed or Enhancement is complete and published. v6 Issues regarding v6
Projects
None yet
Development

No branches or pull requests

2 participants