Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add namespaces to code examples in docs #67

Open
GuySartorelli opened this issue Aug 16, 2022 · 2 comments
Open

Add namespaces to code examples in docs #67

GuySartorelli opened this issue Aug 16, 2022 · 2 comments

Comments

@GuySartorelli
Copy link
Member

Currently most of the code examples in the docs do not include namespaces. This is a holdover from the SS3 days, and can in some cases result in a lack of clarity over whether namespaces should be included (e.g. most yaml config needs it but graphql for example doesn't always need namespaces).

We should add namespaces to all of the code examples so that it's clear how namespaces fit in with Silverstripe code.

@michalkleiner
Copy link
Contributor

Also would be good to set a convention for the examples, e.g. for DOs you always do App\Model\ or Vendor\Module\Model\... and for controllers Vendor\Module\Controllers\... and/or without the Vendor if it's SS core code etc. Just for a bit of consistency so it's not all over the place.

@GuySartorelli
Copy link
Member Author

GuySartorelli commented Nov 20, 2022

That's a good idea. We can start adding that in this card but ultimately that sounds like a great consideration for #11 (I've added it to the list in that card)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants