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

out parameter as new convention #725

Closed
ahojnnes opened this issue Sep 3, 2013 · 6 comments
Closed

out parameter as new convention #725

ahojnnes opened this issue Sep 3, 2013 · 6 comments

Comments

@ahojnnes
Copy link
Member

ahojnnes commented Sep 3, 2013

I suggest to introduce the convention of providing an optional out parameter for all functions (if applicable). Imo this parameter should also be added to existing functions if possible.

Your opinions?

EDIT: out is obviously meant to be a pre-allocated array for output images.

@stefanv
Copy link
Member

stefanv commented Dec 13, 2014

Probably best discussed on the mailing list?

@jni
Copy link
Member

jni commented Dec 13, 2014

+1 on this. We have in_place now for various functions, but out is more general and matches numpy/scipy convention.

@JDWarner
Copy link
Contributor

Out would indeed be more consistent. Might involve a major amount of work. I'm 👍, but not sure it should block the next major release.

@ahojnnes
Copy link
Member Author

No, I agree that it should not block the next release. But we should at least encourage new contributions to provide the parameter if applicable.

@soupault soupault added 🔧 type: Maintenance Refactoring and maintenance of internals ⏩ type: Enhancement Improve existing features and removed 🔧 type: Maintenance Refactoring and maintenance of internals labels Dec 11, 2015
@soupault soupault added new feature and removed ⏩ type: Enhancement Improve existing features labels Jun 11, 2016
@soupault soupault added this to the 0.15 milestone Apr 27, 2018
@sciunto sciunto modified the milestones: 0.15, 0.16 Jan 19, 2019
@sciunto
Copy link
Member

sciunto commented Jan 19, 2019

I postpone this issue to 0.16, and it could be an objective for 1.0

@sciunto sciunto modified the milestones: 0.16, 1.0 Aug 21, 2019
@grlee77 grlee77 added the 📜 type: API Involves API change(s) label Jan 25, 2021
@grlee77 grlee77 added this to To Do in skimage2 API Jan 27, 2021
@grlee77
Copy link
Contributor

grlee77 commented Jan 27, 2021

I am going to close this and suggest future discussion go into #4563

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

No branches or pull requests

7 participants