search

kraftbj / genesis-enews-extended

WordPress widget to provide additional functionality to the Genesis eNews widget.
https://kraft.blog/genesis-enews-extended/
Other
12 stars 15 forks source link

Documentation & Code Standards #14

Closed GaryJones closed 11 years ago

GaryJones commented 11 years ago

Improved documentation and code standards.

Feel free to comment on the diff if you're not sure why I've suggested a change.

kraftbj commented 11 years ago

I thought that the WP plugin headers needed to be first-- putting the docblock headers first is okay?

GaryJones commented 11 years ago

I think they have to be within the first 2kB or so - check the WP functions / class that gets the theme data for the exact number of bytes. They certainly don't have to be exactly first, and this way, the plugin headers can be parsed in a documentation generation app that supports WP plugins, rather than just counting as a file-level long description.

GaryJones commented 11 years ago

FYI, get_file_data() looks at the first 8192b (8kiB) for theme / plugin headers.