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

Fix initialisms #11

Merged
merged 1 commit into from
Jan 28, 2020
Merged

Conversation

jellonek
Copy link
Contributor

https://github.com/golang/go/wiki/CodeReviewComments#initialisms

Change does not touch autogenerated things but we probably should also update service name in

service NsmRegistry {

Signed-off-by: Piotr Skamruk [email protected]

https://github.com/golang/go/wiki/CodeReviewComments#initialisms

Change does not touch autogenerated things

Signed-off-by: Piotr Skamruk <[email protected]>
@edwarnicke
Copy link
Member

So intuitively this feels right to me... but it raises a question... is there a well stated best practice about simply going all caps for things below a certain length (like Ns -> NS) ? Would love to be connected to the wisdom on that :)

@jellonek
Copy link
Contributor Author

As far as I've seen different opinions on that - there is no distinction about length, but only about the source of name - if it's autogenerated - it is mostly (not always, people have sed scripts for that) leaved as generator prepared that (TAL on golang/protobuf#156 ).
Also under the url which I've included in initial description you can find:

This rule also applies to "ID" when it is short for "identifier" (which is pretty much all cases when it's not the "id" as in "ego", "superego"), so write "appID" instead of "appId".

Code generated by the protocol buffer compiler is exempt from this rule. Human-written code is held to a higher standard than machine-written code.

@edwarnicke edwarnicke merged commit 89af60c into networkservicemesh:master Jan 28, 2020
@jellonek jellonek deleted the jell/initialisms branch January 29, 2020 08:41
edwarnicke added a commit to edwarnicke/api that referenced this pull request Jan 30, 2020
networkservicemesh#10 brought in SRIOV changes
after the simplification from:

networkservicemesh#12
and initialism fixes from:

networkservicemesh#11

This fixes those.

Signed-off-by: Ed Warnicke <[email protected]>
edwarnicke added a commit to edwarnicke/api that referenced this pull request Jan 30, 2020
networkservicemesh#10 brought in SRIOV changes
after the simplification from:

networkservicemesh#12
and initialism fixes from:

networkservicemesh#11

This fixes those.

Signed-off-by: Ed Warnicke <[email protected]>
fkautz pushed a commit that referenced this pull request Jan 30, 2020
#10 brought in SRIOV changes
after the simplification from:

#12
and initialism fixes from:

#11

This fixes those.

Signed-off-by: Ed Warnicke <[email protected]>
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.

2 participants