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.

Sign up for GitHub

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

Jump to bottom

chore(doc): contributing don't care about first word of docstring #1433

Merged
merged 1 commit into from
Nov 7, 2024
Merged

chore(doc): contributing don't care about first word of docstring #1433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,21 @@ It's encouraged to add golang and cosmos utilities and shared code to [dymension

2. Do not reuse protobuf field numbers when updating protos. When in doubt, reserve the old number and use a new one.

#### Docstrings

Do not worry about making the first word of the docstring on a public object the same as the object. Feel free to disable any linters/highlighters that pick up on it.

In other words, we are fine with the first version here:

```go

// bla bla
type Foo struct{ }

// Foo bla bla
type Foo struct{ }
```

### References

- https://github.com/dymensionxyz/sdk-utils : Dymension golang and SDK utils library
Expand Down
Loading