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

Clean code comments in macro expansion (from templates) #24

Closed
4meta5 opened this issue Oct 31, 2024 · 9 comments · Fixed by #47
Closed

Clean code comments in macro expansion (from templates) #24

4meta5 opened this issue Oct 31, 2024 · 9 comments · Fixed by #47
Assignees
Labels
good first issue Good for newcomers

Comments

@4meta5
Copy link
Collaborator

4meta5 commented Oct 31, 2024

Raised during review of #1

@mittal-parth
Copy link
Contributor

Hi @4meta5, I can help with this.

Just to make sure we need to address the inline documentation as mentioned in this comment.

Also, do you want me to wait for you to merge the existing changes in #1 before proceeding with this?

Thanks!

@KitHat
Copy link
Member

KitHat commented Nov 3, 2024

Hi @mittal-parth!
We are currently in process of creating an RC.
If you can wait until we create an RC and after that resolve this issue targeting main branch, we would be really grateful :)

@mittal-parth
Copy link
Contributor

Alright noted. I’ll wait :)

@KitHat
Copy link
Member

KitHat commented Nov 3, 2024

I expect RC to be ready in a couple of days max. As soon as #1 and #21 are merged it would be a good point to branch this issue :)

@mittal-parth
Copy link
Contributor

Hi @KitHat!

I think this issue can be closed now seeing that the changes have been implemented in this commit?

@4meta5
Copy link
Collaborator Author

4meta5 commented Nov 6, 2024

@mittal-parth This issue relates to cleaning the code comments in the grouping macro expansions, not adding docs to the top of each file (which was done in that commit). So I think it is still open -- for example #1 (comment) was not addressed in #1

@mittal-parth
Copy link
Contributor

Hi @4meta5 @KitHat!

Started working on this in #47

I have currently made a draft PR with changes for just one group. If that looks good, I can continue the same for others. The comments have been referenced from polkadot-sdk.

Thanks!

@mittal-parth
Copy link
Contributor

Hi @4meta5 @KitHat!
Gentle reminder for this :)

@4meta5
Copy link
Collaborator Author

4meta5 commented Nov 25, 2024

Looks good to me so far @mittal-parth , added some comments but will approve once the same is done for the other groupings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Archived in project
3 participants