DOC Update contributing code docs #379
Conversation
| * public and protected scope (including methods, properties and constants) | ||
| * private static class properties (considered to be configuration variables) | ||
| * yml configuration file structure and value types | ||
| * extension hooks (e.g. `$this->extend('someExtensionHook'));`) |
There was a problem hiding this comment.
| * extension hooks (e.g. `$this->extend('someExtensionHook'));`) | |
| * extension hooks (e.g. `$this->extend('someExtensionHook', $someVariable);`) |
There was a problem hiding this comment.
You can absolutely create valid and useful extension hooks that don't pass arguments - and this isn't documentation about how to create or use extension hooks. But I'll make this change to avoid peer review ping pong since I have to remove that extra bracket anyway.
Done.
|
|
||
| * private scope (with the exception for `private static` properties which aren't annotated with `@internal`) | ||
| * all entities marked as `@internal` | ||
| * yml configuration file default values |
There was a problem hiding this comment.
There's no difference between yml config and private static config - this reads like yml config is out of scope though private static class properties are in scope (it's listed above). Need to clarify
There was a problem hiding this comment.
Yeah I was just copying what was already there and moving it to this page, but if you're saying updating this is in scope then I'll update it.
Done.
| * namespaces, classes, interfaces, enums, and traits | ||
| * public and protected scope (including methods, properties and constants) | ||
| * private static class properties (considered to be configuration variables) | ||
| * yml configuration file structure and value types |
There was a problem hiding this comment.
what is "yml configuration file structure"? And what is a yml "value type"?
There was a problem hiding this comment.
That was existing wording... I've done my best to clarify it now to what I think was intended.
GuySartorelli
force-pushed
the
pulls/4.13/update-contributing-code
branch
from
7634e9a to
5e19111
Compare
- Move note about docs to "before working on a fix" since everything until then is relevant for docs too - Remove note that "Every file view on GitHub has an 'edit this file" link.' because that's confusing at best - Move definition of public API to its own page and refer to it always as "public API", not just "API" - fix a link
GuySartorelli
force-pushed
the
pulls/4.13/update-contributing-code
branch
from
5e19111 to
7e9499f
Compare
Issue