Enhancement: Improve Documentation & Yoda Condition #290
Conversation
index.php
Outdated
| /** | ||
| * Plugin Name: Gutenberg | ||
| * Plugin URI: https://wordpress.github.io/gutenberg/ | ||
| * Description: Prototyping since 1440. Development plugin for the editor focus in core. | ||
| * Version: 0.1 | ||
| * | ||
| * @package WordPress |
There was a problem hiding this comment.
I think we should not add this unless/until this code ships in core.
There was a problem hiding this comment.
Sure, I can remove this for now.
index.php
Outdated
| */ | ||
|
|
||
| // Hook. |
There was a problem hiding this comment.
-1 on this comment and all others that just say "Hook", it doesn't add value.
There was a problem hiding this comment.
@nylen Do you have a suggestion to what should go here? Leaving it without inline docs, feels weird. I appreciate your feedback.
There was a problem hiding this comment.
I would leave it without docs, yes. I would also move the calls immediately below the functions where they are defined. This combination of inline docblock, function code, add_action is enough to be very clear, IMO.
WP core only requires documentation for the do_action or apply_filters calls, not the places where the code actually uses a filter (ref).
index.php
Outdated
| * | ||
| * @param string $hook Screen name. | ||
| * @since 4.8.0 | ||
| */ |
There was a problem hiding this comment.
Also needs a brief explanation.
Enqueues scripts and styles when visiting the top-level page of the Gutenberg editor.
index.php
Outdated
| * Gutenberg's Menu. | ||
| * | ||
| * @since 4.8.0 | ||
| */ |
There was a problem hiding this comment.
This block should describe (even if just in a short sentence) what the function actually does.
Adds a new menu page for the Gutenberg editor.
index.php
Outdated
| * Project. | ||
| * | ||
| * @since 4.8.0 | ||
| */ |
There was a problem hiding this comment.
The main entry point for the Gutenberg editor. Renders the editor on the wp-admin page for the plugin.
|
@nylen Thanks for your feedback. I have made the changes, take a look when you are up for it. |
|
@nylen Kindly, take a look now. |
|
@nylen Thanks for the review. I believe that adding more than 80 characters in a single line of Anywho, thanks! I am on it and will try to contribute more. |
I agree! I'm not a fan of long lines in code either. I used my editor to wrap these lines at 80 chars, rather than breaking at the end of a sentence. If you see one that I missed, let me know and we'll fix it :) |
This PR improves the documentation as per the WordPress Documentation Standards. It also addresses a Yoda Condition error.
Replaces #278 h/t @aduth and @youknowriad
Looking forward!