Skip to content

API annotate IoInterface #15329

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

Merged
merged 1 commit into from
Aug 10, 2018

Conversation

navarr
Copy link
Member

@navarr navarr commented May 18, 2018

IoInterface needs to be @api annotated in order to be useful to third party developers

Contribution checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds on Travis CI are green)

@navarr navarr changed the title API annotated IoInterface API annotate IoInterface May 22, 2018
@sidolov
Copy link
Contributor

sidolov commented May 25, 2018

Hi @navarr , can you describe the scenario when you need to use IoInterface directly?
I think it would better to use \Magento\Framework\Filesystem\DriverInterface for scenarios with the file system, and it's already marked as API.

@navarr
Copy link
Member Author

navarr commented May 25, 2018

@sidolov DriverInterface is important for a class that expects an instance of \Magento\Framework\Filesystem\Io\Ftp or \Magento\Framework\Filesystem\Io\Sftp (which I would also like to see annotated and will create a PR for if this one is accepted)

@navarr
Copy link
Member Author

navarr commented Jun 19, 2018

@sidolov Is my previous description satisfactory?

@magento-engcom-team
Copy link
Contributor

Hi @navarr. Thank you for your contribution.
We will aim to release these changes as part of 2.3.0.
Please check the release notes for final confirmation.

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

Successfully merging this pull request may close these issues.

3 participants