View Issue Details

IDProjectCategoryView StatusLast Update
0023970mantisbthtmlpublic2018-03-04 00:36
Reporterlibregeek Assigned Todregad  
PrioritynormalSeverityminorReproducibilityhave not tried
Status closedResolutionno change required 
Product Version2.11.0 
Summary0023970: Missing print_bracket_link in print_api
Description

The print_bracket_link() in core/print_api.php is missing in 2.11 branch. This method is present in 2.10 branch and it's being used by one of our private plugins. I couldn't find any change/deprecation log on this method.

TagsNo tags attached.

Relationships

related to 0023754 closedatrol Remove unused function print_bracket_link and code cleanup 

Activities

atrol

atrol

2018-02-13 02:12

developer   ~0058842

We don't have a clear rule for removing functions.

The function was removed as part of PR https://github.com/mantisbt/mantisbt/pull/1259 as it's no longer used in code and makes not that much sense in modern UI of 2.x.

@vboctor might comment, as he approved the PR.

cproensa

cproensa

2018-02-17 08:07

reporter   ~0058912

My plugins are affected too
After 1 year of running fine in v2

We don't have a clear rule for removing functions.

We usually deprecate.
However, for all UI related, the experience is that they are removed without a flinch.

atrol

atrol

2018-02-17 10:27

developer   ~0058914

My intend was not to break anything, but just to cleanup code.

@cproensa @libregeek do you think we should reintroduce the function?

To prevent this situation in future, It would be good if you could invest some time to have a look at least at approved PRs.

cproensa

cproensa

2018-02-17 10:40

reporter   ~0058915

do you think we should reintroduce the function?

Not at this point

FYI: I have solved it by copying the old function within my plugin namespace.

libregeek

libregeek

2018-02-21 06:16

reporter   ~0058987

I'm not against deprecating functions, but it would be nice to mention such deprecations in release notes. Thus plugin developers can take a quick look at the release notes and fix it without doing a blind upgrade and breaking the production environments.

dregad

dregad

2018-02-22 18:39

developer   ~0059010

it would be nice to mention such deprecations in release notes

I've changed issue 0023754's title to make the function removal appear in the change log.

The function was removed as part of PR https://github.com/mantisbt/mantisbt/pull/1259

The "clean" way would have been to leave the function in, while having it trigger a USER_DEPRECATED error, and actually remove it in a later release. To keep in mind for future code cleanups :-)

atrol

atrol

2018-02-23 17:03

developer   ~0059034

The "clean" way would have been to leave the function in ...

Any function?
Isn't our official API just SOAP, REST and the events?

Does it mean that we also have to announce changes like incompatible function signature changes, removal/renaming of CSS classes, ...?