Making WordPress.org

Opened 16 months ago

Closed 9 months ago

#6654 closed enhancement (wontfix)

Documenting the globals in various files into the wordpress.org

Reported by: viralsampat's profile viralsampat Owned by:
Milestone: Priority: lowest
Component: General Keywords: has-patch dev-feedback reporter-feedback
Cc:

Description

Hello Team,

Today, I checked meta trunk and its core files, I found a few files inside "wordpress.org" where we need to document global variables.

During QAing I found that in some places it is already documented, But in some places, we need to improve it.

Here, I have added the files path:

/wordpress.org/public_html/wp-content/themes/pub/wporg-photos/functions.php
/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/functions.php
/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/template-parts/plugin-single.php
/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/template-parts/section-advanced.php
/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/template-parts/section-blocks.php
/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/template-parts/section.php
/wordpress.org/public_html/wp-content/themes/pub/wporg-support/functions.php

Attachments (12)

6654.diff (4.0 KB) - added by viralsampat 16 months ago.
Here, I have added my patch.
6664.diff (543 bytes) - added by viralsampat 16 months ago.
I have checked from my end and found few other files. So, I have added my patch.
6664.2.diff (294 bytes) - added by viralsampat 16 months ago.
I have checked from my end and found few other files. So, I have added my patch.
6654.2.diff (294 bytes) - added by viralsampat 16 months ago.
I have checked from my end and found a few other files. So, I have added my patch.
6654.3.diff (543 bytes) - added by viralsampat 16 months ago.
I have checked from my end and found a few other files. So, I have added my patch.
6654.4.diff (887 bytes) - added by viralsampat 15 months ago.
I have checked from my end and found a few other files. So, I have added my patch.
6654.5.diff (1.6 KB) - added by viralsampat 15 months ago.
I have checked from my end and found a few other files. So, I have added my patch.
6654.patch (8.7 KB) - added by viralsampat 10 months ago.
I have checked above mentioned issue and founds few more files. I have applied its patch.
6654.2.patch (1.1 KB) - added by viralsampat 10 months ago.
I have checked above mentioned issue and founds few more files. I have applied its patch.
6654.3.patch (2.3 KB) - added by viralsampat 10 months ago.
I have checked above mentioned issue and founds few more files. I have applied its patch.
6654.4.patch (2.9 KB) - added by viralsampat 10 months ago.
I have checked above mentioned issue and founds few more files. I have applied its patch.
6654.5.patch (3.3 KB) - added by viralsampat 10 months ago.
I have checked above mentioned issue and founds few more files. I have applied its patch.

Download all attachments as: .zip

Change History (16)

@viralsampat
16 months ago

Here, I have added my patch.

@viralsampat
16 months ago

I have checked from my end and found few other files. So, I have added my patch.

@viralsampat
16 months ago

I have checked from my end and found few other files. So, I have added my patch.

#1 @viralsampat
16 months ago

Hello @team

Recently, I added two new patches which are related to this ticket, But by mistake, I wrote the wrong ticket name.

6664.diff​ (543 bytes) - added by viralsampat 3 minutes ago.
I have checked from my end and found a few other files. So, I have added my patch.

6664.2.diff​ (294 bytes) - added by viralsampat 3 minutes ago.
I have checked from my end and found a few other files. So, I have added my patch.

So, if possible then please delete these both patches from the list.

Here, I am adding the same patch with its correct ticket number.

Thanks,

@viralsampat
16 months ago

I have checked from my end and found a few other files. So, I have added my patch.

@viralsampat
16 months ago

I have checked from my end and found a few other files. So, I have added my patch.

@viralsampat
15 months ago

I have checked from my end and found a few other files. So, I have added my patch.

@viralsampat
15 months ago

I have checked from my end and found a few other files. So, I have added my patch.

@viralsampat
10 months ago

I have checked above mentioned issue and founds few more files. I have applied its patch.

@viralsampat
10 months ago

I have checked above mentioned issue and founds few more files. I have applied its patch.

@viralsampat
10 months ago

I have checked above mentioned issue and founds few more files. I have applied its patch.

#2 @dd32
10 months ago

  • Priority changed from normal to lowest

@viralsampat The contributions are welcome, but the majority of these do not appear to add anything of benefit to the developer experience.

Simply documenting a global variable that is referred to as global 2 lines later doesn't seem useful to me, especially if it doesn't actually provide context as to what it is.

Can you explain your reasonings as to why this should be committed?

#3 @viralsampat
10 months ago

Hello @dd32

Thank you so much for sharing your feedback.

Yes, you are right. Most of these do not add anything of benefit to the developer experience.

I have added this change just because make it consistence. We checked all the files and found that in some places, we followed all the rules, But in some places, we didn't mention global documentation.

So, it is not impacting more, But we will add this then we will maintain its consistency.

Thanks,

@viralsampat
10 months ago

I have checked above mentioned issue and founds few more files. I have applied its patch.

@viralsampat
10 months ago

I have checked above mentioned issue and founds few more files. I have applied its patch.

#4 @dd32
9 months ago

  • Resolution set to wontfix
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.