Global documentation update #967

New issue

Open

opened 2025-12-28 17:14:48 +00:00 by sami · 0 comments

sami commented

2025-12-28 17:14:48 +00:00

Owner

Originally created by @AnnaShaleva on GitHub (Aug 9, 2022).

We need to ensure that our documentation is properly rendered by godoc (wrt https://tip.golang.org/doc/comment) which includes the following checks:

Check that lists are displayed as lists (like it is don in https://github.com/nspcc-dev/neo-go/pull/2634#discussion_r941284261).
Use doc links for the code structures and functions where possible (like it is done in https://github.com/nspcc-dev/neo-go/pull/2634#discussion_r940306146).

Originally created by @AnnaShaleva on GitHub (Aug 9, 2022). We need to ensure that our documentation is properly rendered by godoc (wrt https://tip.golang.org/doc/comment) which includes the following checks: 1. Check that lists are displayed as lists (like it is don in https://github.com/nspcc-dev/neo-go/pull/2634#discussion_r941284261). 2. Use doc links for the code structures and functions where possible (like it is done in https://github.com/nspcc-dev/neo-go/pull/2634#discussion_r940306146).