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

Fix: some edit proposals #226

Conversation

TheDZhon
Copy link
Contributor

Propose a few edits to be done for #225 🙏

@TheDZhon TheDZhon requested a review from a team as a code owner June 29, 2023 08:47
@TheDZhon TheDZhon requested a review from Psirex June 29, 2023 08:47
@TheDZhon TheDZhon requested a review from folkyatina June 29, 2023 08:51
Copy link
Member

@folkyatina folkyatina left a comment

Choose a reason for hiding this comment

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

Looks fine, thanks.

Copy link
Contributor

@Psirex Psirex left a comment

Choose a reason for hiding this comment

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

Looks good to me👍🏻

The only thing I didn't understand was our convention about code blocks with method signatures. In other docs, somewhere we mention the mutability/visibility keywords and somewhere not. In my opinion, the "truncated" declaration is less useful for the docs reader, but it's not a strong opinion.

@TheDZhon
Copy link
Contributor Author

Looks good to me👍🏻

The only thing I didn't understand was our convention about code blocks with method signatures. In other docs, somewhere we mention the mutability/visibility keywords and somewhere not. In my opinion, the "truncated" declaration is less useful for the docs reader, but it's not a strong opinion.

Yeah, I see your point.

Although I am a bit positive about showing only mutability (view / pure / none). However, it's already proclaimed int the heading titles 🤔

@TheDZhon TheDZhon merged commit 55be92d into feat/oracle-report-sanity-checker Jun 29, 2023
@TheDZhon TheDZhon deleted the feat/oracle-report-sanity-checker-proposals-dzhon branch June 29, 2023 12:00
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