Documentation improvements #3526
Conversation
Signed-off-by: Roman Khimov <[email protected]>
| @@ -33,6 +33,13 @@ a dialect of Go rather than a complete port of the language: | |||
| it's up to the programmer whether assert can be performed successfully. | |||
There was a problem hiding this comment.
Format of the commit message is questionable. @AnnaShaleva would not like that.
There was a problem hiding this comment.
Do you think it violates https://github.com/nspcc-dev/.github/blob/master/git.md#commit-messages?
There was a problem hiding this comment.
yes,
The following format is expected:
subsystem: short description (up to 80 symbols, better up to 60)
Long description with references, links...
in the first line there are no links or refs. At least they are not mentioned in https://github.com/nspcc-dev/.github/blob/master/git.md#commit-messages
There was a problem hiding this comment.
While I think it's compliant (there are no limits of what short description can or can not include as long as it's short) and there are numerous commits like f4b61b5, b1bb12d, d2a7162, eade327 and others, I can at the same time say that @AnnaShaleva has never wrote a short description like that in ~1715 commits that I can see in this repo (~116 commits in neo-bench are the same). I think it's still OK, but maybe we can have our policies improved one way or another.
There was a problem hiding this comment.
in the first line there are no links or refs.
I'm OK with the commit formatting presented in this PR, links are allowed both in the commit header and in the body. It's just about my personal preferences, I try to keep my own commits with links in the body, not in the header.
| @@ -403,3 +403,25 @@ where: | |||
|
|
|||
| Note that `Transaction` is a NeoGo extension that isn't supported by the NeoC# | |||
| node and must be disabled on the public Neo N3 networks. | |||
|
|
|||
| ## DB compatibility | |||
There was a problem hiding this comment.
Needs the same indent as above.
There was a problem hiding this comment.
We have a list above and this is a new section, but I've improved the list a bit anyway.
Signed-off-by: Roman Khimov <[email protected]>
roman-khimov
force-pushed
the
improve-doc
branch
from
f4ddf4d to
5d29a3f
Compare
Fix some of the old bugs related to this.