WordPress.org

Making WordPress.org

Opened 5 years ago

Closed 3 years ago

#607 closed defect (fixed)

Add information about error reporting in the code reference

Reported by: wedi Owned by: coffee2code
Milestone: Priority: normal
Component: Developer Hub Keywords:
Cc:

Description

I just found a content error in the Code Reference. Of course I wanted to report it but I couldn't find the right place for the issue. If it's made easy enough (e.g. like a wiki) I would have corrected it directly along the way. Finally I decided to report the problem here (#606) to raise awareness although this might be the wrong place.

Please add some information about error reporting or even patching to the Code Reference. Ideally there would be a link on every page that leads to a place where the user can report or correct the error without further ado.

Change History (6)

#1 @Otto42
5 years ago

The code reference is automatically built from the documentation in the core code itself. Any errors you find are errors in WordPress itself and can be reported through the core bug tracker, along with patches to the core code and such.

Should this be better explained somewhere? Not sure how to word that, really.

#2 @wedi
5 years ago

The explanation you just gave is short and great to understand! Maybe one could add a small info box somewhere? Maybe on the starting page or even better a call to action next to the simple "View on Trac" link?

Example:
This code reference page is automatically built from the inline documentation in the WordPress core source code itself.
View the corresponding source code on Trac
Any errors you find are errors in WordPress itself. Please report any issues to the core bug tracker or become a part of WordPress and submit a patch.

It would be amazing if the a link would point to a guide like "Step-by-step: How to report and patch issues in the WordPress Code Reference".

The experienced core dev has no problem fixing such an issue in a minute but the ordinary plugin author is initially scared. That's why I suggest to take him by the hand and guide him through the first steps, just like @georgestephanis kindly offered in my initial issue #606 but on a more general level of course. I think that's a great opportunity to get more devs involved (if that's needed). The hurdle for a documentation patch is much lower than for a code one where other issues like 'Can I keep up with these experienced core devs?' come into play. And once the first patch has landed people will probably see (I'll tell you afterwards) there's no magic formula involved.

Last edited 5 years ago by wedi (previous) (diff)

#3 @siobhan
5 years ago

Thanks for the feedback! We're working on a way to make this clearer. More info very soon :)

This ticket was mentioned in Slack in #meta-devhub by siobhan. View the logs.


5 years ago

This ticket was mentioned in Slack in #meta-devhub by keesiemeijer. View the logs.


3 years ago

#6 @coffee2code
3 years ago

  • Owner set to coffee2code
  • Resolution set to fixed
  • Status changed from new to closed

In 3787:

developer.wordpress.org: Explicitly indicate feedback is acceptable via the same form as user contributed notes.

See #981.
Fixes #607.

Note: See TracTickets for help on using tickets.