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

rename IpfsDHT to DHT #191

Closed
wants to merge 1 commit into from
Closed

rename IpfsDHT to DHT #191

wants to merge 1 commit into from

Conversation

Stebalien
Copy link
Member

(and add a type alias to avoid breaking anything)

Blocked on the pipelining PR (would be painful to rebase again).

(and add a type alias to avoid breaking anything)
@ghost ghost assigned Stebalien Sep 1, 2018
@ghost ghost added the status/in-progress In progress label Sep 1, 2018
@Stebalien Stebalien added status/deferred Conscious decision to pause or backlog status/blocked Unable to be worked further until needs are met and removed status/in-progress In progress labels Sep 1, 2018
@bigs bigs added exp/novice Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature and removed help wanted Seeking public contribution on this issue exp/novice Someone with a little familiarity can pick up labels Sep 11, 2018
@anacrolix
Copy link
Contributor

I would suggest using a word other than DHT. Node, Client, Server, Instance or something like that. This gives consumers of the package a variable naming suggestion other than dht which clashes with the package name. It's also obvious that it's already related to DHT in some way due to the package name. I can redo this PR to implement this if desired.

@vyzo
Copy link
Contributor

vyzo commented Jan 9, 2019

I am fine with calling it DHT.

@anacrolix
Copy link
Contributor

Per the Kademlia nomenclature, I think Node is most appropriate. It also avoids naming stutter. DHT is not accurate, and is a generic name for the "main thing" in the package. DHT is the sum of all the nodes operating together, and a name for the technology. What the dht package is providing here is an instance of a node. The consumer of the API wants to write:

dht := dht.NewDHT(...)

But cannot, due to default naming clashes. This kind of thing is very annoying in Go APIs, and results in different users coming up with their own inconsistent variable names.

@anacrolix anacrolix mentioned this pull request Jan 10, 2019
@anacrolix
Copy link
Contributor

I'm closing this as it's rotting. There's no consensus on renaming yet. See also #223 (comment).

@anacrolix anacrolix closed this Jan 22, 2019
@ghost ghost removed the status/deferred Conscious decision to pause or backlog label Jan 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement A net-new feature or improvement to an existing feature status/blocked Unable to be worked further until needs are met
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants