[MDL-46585] String deprecation process (starting with deprecating 'hidden') - Moodle Tracker

XML

Word

Printable

Type: Improvement
Status: Closed
Priority: Minor
Resolution: Fixed
Affects Version/s: 2.7.1
Fix Version/s: 2.8
Component/s: Badges, Calendar, Language, Portfolio, Questions, Quiz, Repositories, Roles / Access
Labels:
- api_change
- ci
- triaged

Affected Branches:
MOODLE_27_STABLE
Fixed Branches:
MOODLE_28_STABLE
Pull from Repository:
git://github.com/marinaglancy/moodle.git
Pull Master Branch:
wip-~~MDL-46585~~-master
Pull Master Diff URL:
https://github.com/marinaglancy/moodle/compare/moodle:master...wip-MDL-46585-master
Documentation link:
https://docs.moodle.org/dev/String_deprecation
Testing Instructions:
Hide

Unfortunately it's difficult to check that removed string is actually not used. I guess behat tests and approval from component leads should be sufficient

Testing string deprecation:

insert echo get_string('hidden', 'calendar'); somewhere, render the page and make sure debugging message is displayed

add some existing or non-existing strings to lang/en/deprecated.txt, make sure unittest lib/tests/string_manager_standard_test.php passes or fails
Show
Unfortunately it's difficult to check that removed string is actually not used. I guess behat tests and approval from component leads should be sufficient Testing string deprecation: insert echo get_string('hidden', 'calendar'); somewhere, render the page and make sure debugging message is displayed add some existing or non-existing strings to lang/en/deprecated.txt, make sure unittest lib/tests/string_manager_standard_test.php passes or fails

The issue first was created to deal with 6 unnecessary 'hidden' strings but grew up into string deprecation process.

lang/en/badges.php:$string['hidden'] = 'Hidden';

lang/en/calendar.php:$string['hidden'] = 'hidden';

lang/en/portfolio.php:$string['hidden'] = 'Hidden';

lang/en/question.php:$string['hidden'] = 'Hidden';

lang/en/repository.php:$string['hidden'] = 'Hidden';

lang/en/role.php:$string['hidden'] = 'Hidden';

Two "hidden"s remain because they are currently used:

lang/en/grades.php:$string['hidden'] = 'Hidden';

mod/scorm/lang/en/scorm.php:$string['hidden'] = 'Hidden';

blocks

MDLSITE-3395 Periodically import deprecated strings to AMOS

has a non-specific relationship to

MDL-45336 Core_question uses strings from quiz

MDLSITE-3397 Improve doc on String deprecation

Participants:: CiBoT, Dan Poltawski, David Mudrák (@mudrd8mz), Helen Foster, John Okely, Koen Roggemans, Marina Glancy, Tim Hunt

Component watchers:: Yuliya Bozhko, Amaia Anabitarte, Carlos Escobedo, Laurent David, Sabina Abellan, Sara Arjona (@sarjona), David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo, David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo, David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo, Safat Shahin, Tim Hunt, Ilya Tregubov, Kevin Percy, Mathew May, Mihail Geshoski, Shamim Rezaie, Tim Hunt, Ilya Tregubov, Kevin Percy, Mathew May, Mihail Geshoski, Shamim Rezaie, David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo, David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo