Do not duplicate structure of notification events in `config.yml` and `doc.go` #101

New issue

Open

opened 2025-12-28 18:08:31 +00:00 by sami · 1 comment

sami commented

2025-12-28 18:08:31 +00:00

Owner

Originally created by @cthulhu-rider on GitHub (Sep 30, 2022).

What's the declarative priority of structure of the contract notification events - config.yml or doc.go?

I propose to not duplicate places where notifications are defined. Other place can just reference to the definition source. File config.yml seems more appropriate for events' documentation to me. We can mention all accompanying information in YAML comments.

Originally created by @cthulhu-rider on GitHub (Sep 30, 2022). What's the declarative priority of structure of the contract notification events - `config.yml` or `doc.go`? I propose to not duplicate places where notifications are defined. Other place can just reference to the definition source. File `config.yml` seems more appropriate for events' documentation to me. We can mention all accompanying information in YAML comments.

sami added the

question

documentation

good first issue

labels

2025-12-28 18:08:31 +00:00

sami commented

2025-12-28 18:08:32 +00:00

Author

Owner

@alexvanin commented on GitHub (Oct 2, 2022):

Package documentation includes notification description because it automatically included into neofs-spec, see neofs-spec#52.

Consider changing this process before removing notification descriptions from package docs.

@alexvanin commented on GitHub (Oct 2, 2022): Package documentation includes notification description because it automatically included into neofs-spec, see [neofs-spec#52](https://github.com/nspcc-dev/neofs-spec/pull/52). Consider changing this process before removing notification descriptions from package docs.