Skip to content

Comments

doc: Add docs for EthApi#9550

Closed
tcoratger wants to merge 2 commits intoparadigmxyz:mainfrom
tcoratger:eth-api-doc
Closed

doc: Add docs for EthApi#9550
tcoratger wants to merge 2 commits intoparadigmxyz:mainfrom
tcoratger:eth-api-doc

Conversation

@tcoratger
Copy link
Contributor

Should close #9540.

Copy link
Collaborator

@mattsse mattsse left a comment

Choose a reason for hiding this comment

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

lgtm, pending @emhane

@mattsse mattsse added the C-docs An addition or correction to our documentation label Jul 16, 2024
@emhane
Copy link
Collaborator

emhane commented Jul 17, 2024

this is too much chagpt fluff

@emhane emhane closed this Jul 17, 2024
@tcoratger
Copy link
Contributor Author

Hey @emhane,

Just to tell you that in fact I used ChatGPT (that seems normal to me for generating documentation in 2024, right?). However, I spent about 30 minutes writing the entire OpEthApi example (in documentation form) with also the definition for myself of each helper trait:

/// - `EthApiSpec`: Defines basic Ethereum network information and status.
/// - `SpawnBlocking`: Handles task spawning and concurrency.
/// - `LoadFee`: Manages fee-related data loading and caching.
/// - `Call`: Handles EVM call operations.
/// - `LoadState`: Manages state loading and caching.
/// - `EthState`: Provides Ethereum state-related functionality.
/// - `EthCall`: Implements Ethereum call-related methods.
/// - `EthFees`: Handles fee estimation and history.
/// - `Trace`: Provides tracing functionality for transactions.
/// - `AddDevSigners`: Manages development signers for testing.
/// - `UpdateRawTxForwarder`: Allows updating of raw transaction forwarding behavior.

that ChatGPT cannot guess (at least not from what I understood). Then in fact when I pass all this context to ChatGPT (i.e. more or less all the main documentation of the EthApi), he is much better than me at organizing the pieces and writing clear documentation (and I imagine that no matter who by the way).

But in general, I don't really understand why you close PRs without review and feedback loops. Every time I feel like I'm doing a lot of work for nothing. This is not a criticism at all, if you feel that this PR should not be merged, you are the one responsible for the code, I can only agree but I would like to understand better:

  • On this PR we could have removed the parts that don't suit you, shortened it, removed information, added what seemed missing to you.
  • Here refactor: use BundleBuilder as a state builder #8861 it's the same I didn't really understand because there was no ChatGPT and a lot of super useful work to do on it. I saw a comment saying that we probably had to modify the BundleBuilder API but that's not a problem, we could have done it. But ultimately it was abandoned and everything was closed?

cc @mattsse

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

Labels

C-docs An addition or correction to our documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for EthApi

3 participants