Skip to content

Deprecate and add a remplacement function to get country name - #4053

Open
lejeana wants to merge 3 commits into
mainfrom
3571-confuse-country-api
Open

Deprecate and add a remplacement function to get country name#4053
lejeana wants to merge 3 commits into
mainfrom
3571-confuse-country-api

Conversation

@lejeana

@lejeana lejeana commented Aug 20, 2026

Copy link
Copy Markdown

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?

#3571

What kind of change does this PR introduce?

Deprecate the function getName() as a function called name() already exist which lead to confusion. Added a new function with the same behaviour and whose name is more explicit : getFullName().

What is the current behavior?

#3571

What is the new behavior (if this is a feature change)?
Deprecated a function and add a remplacement function with the same behaviour.

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

Change call to function Country::getName() to Country::getFullName() as Country::getName() is now deprecated and will later be removed.
Both functions have the same behaviour, hence no more change is required.

Deprecate the function getName() as a function called name() already exist which lead to confusion.
Added a new function with the same behaviour and whose name is more explicit : getFullName().

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana lejeana linked an issue Aug 20, 2026 that may be closed by this pull request
@alicecaron alicecaron moved this to Waiting for review in Release 09/2026 Aug 21, 2026
alicecaron
alicecaron previously approved these changes Aug 21, 2026
@github-project-automation github-project-automation Bot moved this from Waiting for review to Approved in Release 09/2026 Aug 21, 2026
@alicecaron
alicecaron requested a review from colineplqt August 21, 2026 09:51

@colineplqt colineplqt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this pull request. Could you modify the code so that the calls to getName() are replaced by getFullName?

…unction

replace call to deprecated function getName() by its replacement function getFullName()

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana

lejeana commented Aug 24, 2026

Copy link
Copy Markdown
Author

calls to getName() are now replaced by the new function getFullName()

also, fixture deprecated allows to precise if the function will be removed in futher version, should we set it to true?

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@sonarqubecloud

Copy link
Copy Markdown

@colineplqt

Copy link
Copy Markdown
Member

calls to getName() are now replaced by the new function getFullName()

also, fixture deprecated allows to precise if the function will be removed in futher version, should we set it to true?

I think you can add the version since when the method is deprecated (7.4.0). I would say that it is a function that could be removed after some time, but both is fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Approved

Development

Successfully merging this pull request may close these issues.

Confuse Country API

3 participants