Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change return value of adding system framework #466

Merged
merged 1 commit into from
Feb 11, 2017

Conversation

keith
Copy link
Member

@keith keith commented Feb 10, 2017

Previously it looked like this function was intending to return a file
reference of the newly created framework, but instead it was returning
the original array of strings. This change returns the array of file
references so consumers can manipulate them as needed.

@keith
Copy link
Member Author

keith commented Feb 10, 2017

It doesn't look like CP uses the return value from this function anywhere, so no other changes are required. But this is a breaking change so I'm not sure if we want to do this or not. If we do I'll add a CHANGELOG entry.

@keith
Copy link
Member Author

keith commented Feb 10, 2017

If this behavior is desired I'll have to update the docstrings as well

@supermarin
Copy link

@keith why is this a breaking change?

@keith
Copy link
Member Author

keith commented Feb 10, 2017

I guess it's not, I thought that it was intentionally returning the input array of strings, but that's actually just a side effect from ruby I guess, according to the docstring.

@keith
Copy link
Member Author

keith commented Feb 10, 2017

I got tricked by the ref at the bottom of the each into thinking it was trying to return that.

@segiddins
Copy link
Member

👍🏻 with a changelog entry

@@ -308,7 +308,7 @@ def new_shell_script_build_phase(name = nil)
# @return [void]
Copy link
Member

Choose a reason for hiding this comment

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

The documented return type was void, so nobody should have been expecting a stable return value before. So this is not a breaking change 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

🎉

@alloy
Copy link
Member

alloy commented Feb 11, 2017

It looks like the ref at the bottom was left-over from previous code that did indeed return the reference 092a125#diff-adc2f4667b1ea4b75e763b2aa6cd2b30L146.

@supermarin
Copy link

@keith please update documentation return type

Previously it looked like this function was intending to return a file
reference of the newly created framework, but instead it was returning
the original array of strings. This change returns the array of file
references so consumers can manipulate them as needed.
@keith keith force-pushed the ks/system-framework-return branch from 0b9116b to af8c79d Compare February 11, 2017 00:57
@keith
Copy link
Member Author

keith commented Feb 11, 2017

Updated. Would love a second look!

@endocrimes endocrimes merged commit 48d7e22 into master Feb 11, 2017
@endocrimes endocrimes deleted the ks/system-framework-return branch February 11, 2017 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants