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

docs: extension readme #394

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: extension readme #394

wants to merge 3 commits into from

Conversation

Daanvdplas
Copy link
Collaborator

No description provided.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.41%. Comparing base (3cdb9b5) to head (102e48f).
Report is 2 commits behind head on main.

@@             Coverage Diff             @@
##             main     #394       +/-   ##
===========================================
+ Coverage   54.34%   68.41%   +14.06%     
===========================================
  Files          49       70       +21     
  Lines        5025    11838     +6813     
  Branches     5025    11838     +6813     
===========================================
+ Hits         2731     8099     +5368     
- Misses       2245     3482     +1237     
- Partials       49      257      +208     

see 21 files with indirect coverage changes

Copy link
Collaborator

@chungquantin chungquantin left a comment

Choose a reason for hiding this comment

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

Nice to have basic examples (similar to the one in mock test). In overall, I'm happy with the doc, very well-written!

@Daanvdplas
Copy link
Collaborator Author

You mean adding examples to the readme?

@chungquantin
Copy link
Collaborator

You mean adding examples to the readme?

Looking at the existing code in the testnet runtime, there are a lot of noises aside from the direct configuration of the module.

Something like the code snippet below could be useful for someone that interested to use this in their code.

struct ExampleFunction;

...

pub(crate) type Functions = (
	ExampleFunction<WithFuncId<ExampleFuncId>, Runtime>,
);

#[derive(Default)]
pub struct Config;
impl super::Config for Config {
	type Functions = Functions;

	const LOG_TARGET: &'static str = "pop-chain-extension";
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants