Skip to content

Make NI-SWITCH init_with_topology private#674

Merged
marcoskirsch merged 5 commits intomasterfrom
make_init_private
Dec 11, 2017
Merged

Make NI-SWITCH init_with_topology private#674
marcoskirsch merged 5 commits intomasterfrom
make_init_private

Conversation

@Fladolcetta
Copy link
Copy Markdown
Contributor

[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

Comment thread CHANGELOG.md Outdated
* ### NI-Switch
* #### Added
* #### Changed
* Made init_with_topology a private function.
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.

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.

Comment thread CHANGELOG.md Outdated
* #### Added
* #### Changed
* #### Removed
* Removed init_with_topology. Clients should use niswitch.Session.init(). See #660.
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.

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 marcoskirsch merged commit 0e4310c into master Dec 11, 2017
@Fladolcetta Fladolcetta deleted the make_init_private branch December 12, 2017 20:27
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.

NI-SWITCH Init with topology is exposed and should be made private.

2 participants