Skip to content

Commit

Permalink
chore(doc): contributing don't care about first word of docstring (#1433
Browse files Browse the repository at this point in the history
)
  • Loading branch information
danwt authored Nov 7, 2024
1 parent 6dcb29a commit 8493c65
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Contributing.md
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

0 comments on commit 8493c65

Please sign in to comment.