ooni-probe-cli/internal/model/README.md

# Package github.com/ooni/probe-cli/internal/model

Shared data structures and interfaces. We include in this
package the most fundamental types. Use `go doc` to get
more thorough documentation about what is inside this package
and when to put a type inside this package.
doc(step-by-step): readability improvements (#820) This diff contains readability improvements for the step-by-step design document. Co-authored-by: Simone Basso <bassosimone@gmail.com> 2022-06-30 09:55:18 +02:00			`# Package github.com/ooni/probe-cli/internal/model`
refactor: interfaces and data types into the model package (#642) ## Checklist - [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md) - [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885 - [x] related ooni/spec pull request: N/A Location of the issue tracker: https://github.com/ooni/probe ## Description This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package. The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity. An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other. This is what I want to move in `internal/model`: - [x] most important interfaces from `internal/netxlite` - [x] everything that was previously part of `internal/engine/model` - [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage 2022-01-03 13:53:23 +01:00
			`Shared data structures and interfaces. We include in this`
			package the most fundamental types. Use `go doc` to get
			`more thorough documentation about what is inside this package`
			`and when to put a type inside this package.`