nandra / mender-server-rest-go-client

0 stars 0 forks source link

Naming issues #1

Open melias122 opened 4 years ago

melias122 commented 4 years ago

I suggest to rename repository to something short and simple such as menderclient or menderrc as current name sounds too verbose.

Also most go developer would expect repository name as package name, which is not the case now.

This will bring simplification see example, current state when using this repo

package main

import (
    "github.com/nandra/mender-server-rest-go-client"
)

func main() {
    c:= mender_rest_api_client.NewRestClient
}

after rename

package main

import (
    "github.com/nandra/menderrc"
)

func main() {
    c:= menderrc.NewRestClient
}
nandra commented 4 years ago

@melias122 make sense. Naming was just something I just add blindly and didn't think much about that. I think merderrrc is also bit misleading how about menderRest? Thanks.

melias122 commented 4 years ago

I would suggest something short and lowercase thats why I suggested menderrc (Mender Rest Client). Such names are not uncommon in go community. For more inspiration you can search through https://pkg.go.dev. There is also another option leave it as is (repo name) and make subpackage 'rest', so clients would use rest.NewClient for example.

po 5. 10. 2020 o 8:26 Marek Belisko notifications@github.com napísal(a):

@melias122 https://github.com/melias122 make sense. Naming was just something I just add blindly and didn't think much about that. I think merderrrc is also bit misleading how about menderRest? Thanks.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/nandra/mender-server-rest-go-client/issues/1#issuecomment-703425523, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAH25NSJZFFD2HAVQ445IV3SJFRKDANCNFSM4SCUXCJA .

nandra commented 4 years ago

Ok let’s stick with menderrc should I rename repo?

On Mon, 5 Oct 2020 at 16:53, Martin Eliáš notifications@github.com wrote:

I would suggest something short and lowercase thats why I suggested

menderrc (Mender Rest Client). Such names are not uncommon in go community.

For more inspiration you can search through https://pkg.go.dev. There is

also another option leave it as is (repo name) and make subpackage 'rest',

so clients would use rest.NewClient for example.

po 5. 10. 2020 o 8:26 Marek Belisko notifications@github.com napísal(a):

@melias122 https://github.com/melias122 make sense. Naming was just

something I just add blindly and didn't think much about that. I think

merderrrc is also bit misleading how about menderRest? Thanks.

You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub

< https://github.com/nandra/mender-server-rest-go-client/issues/1#issuecomment-703425523 ,

or unsubscribe

< https://github.com/notifications/unsubscribe-auth/AAH25NSJZFFD2HAVQ445IV3SJFRKDANCNFSM4SCUXCJA

.

— You are receiving this because you commented.

Reply to this email directly, view it on GitHub https://github.com/nandra/mender-server-rest-go-client/issues/1#issuecomment-703684404, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAKEZCSMAQGWRE4ZFFKKMDSJHMVFANCNFSM4SCUXCJA .

-- Sent from Gmail Mobile

melias122 commented 4 years ago

Yes, that would be good :+1: