[wp-trac] [WordPress Trac] #41380: Documentation needs improvement.

[WordPress Trac]

#41380: Documentation needs improvement.
--------------------------+---------------------------
 Reporter:  ronakganatra  |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  closed
 Priority:  normal        |   Milestone:  4.9
Component:  HTTP API      |     Version:
 Severity:  normal        |  Resolution:  fixed
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+---------------------------
Changes (by DrewAPicture):

 * milestone:  Awaiting Review => 4.9


Comment:

 Hi @ronakganatra, thanks for the patch. I've gone ahead and merged part of
 your patch and wanted to give you a couple of pointers for future tickets:

 1) It would be very helpful if you could try to write more specific ticket
 summaries when submitting to trac in the future. I went ahead and updated
 it for you here :-)

 2) It would also be helpful to generate your patches from the WordPress
 root instead of the directory the file is located in. This is because most
 core contributors will be using tools like the
 [https://make.wordpress.org/core/handbook/testing/patch/#using-grunt grunt
 patch] tool to apply patches, which means patches not generated from the
 root may not apply correctly.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/41380#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform