Make NI-SWITCH init_with_topology private #674
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcoskirsch
previously requested changes
Dec 7, 2017
CHANGELOG.md
Outdated
| @@ -25,6 +25,7 @@ All notable changes to this project will be documented in this file. | |||
| * ### NI-Switch | |||
| * #### Added | |||
| * #### Changed | |||
| * Made init_with_topology a private function. | |||
There was a problem hiding this comment.
I think you can put this under Removed. One thing we should do as well and we haven't is better document the rationale behind some of these decisions. In most cases it's as simple as saying:
Removed init_with_topology. Clients should use niswitch.Session.init(). See #660.
Of course, we need to be good about explaining things in our issues, which is not always the case. Remember this is all open to the world to see.
marcoskirsch
reviewed
Dec 7, 2017
CHANGELOG.md
Outdated
| @@ -26,6 +26,7 @@ All notable changes to this project will be documented in this file. | |||
| * #### Added | |||
| * #### Changed | |||
| * #### Removed | |||
| * Removed init_with_topology. Clients should use niswitch.Session.init(). See #660. | |||
There was a problem hiding this comment.
There is no niswitch.Session.init()
There is niswitch.Session.__init__(). I think Markdown rendering screwed things up. You can change that to
Clients should use niswitch.Session() constructor.
marcoskirsch
approved these changes
Dec 11, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[x ] This contribution adheres to CONTRIBUTING.md.
[x ] I've updated CHANGELOG.md if applicable.
What does this Pull Request accomplish?
Makes the initialization function private for NI-SWITCH
List issues fixed by this Pull Request below, if any.
What testing has been done?
Tox