Skip to content

Fixes example service name example consistency#1358

Merged
inclement merged 1 commit into
kivy:masterfrom
AndreMiras:feature/minor_service_doc_clarification
Sep 7, 2018
Merged

Fixes example service name example consistency#1358
inclement merged 1 commit into
kivy:masterfrom
AndreMiras:feature/minor_service_doc_clarification

Conversation

@AndreMiras

Copy link
Copy Markdown
Member

It makes it easier to understand by using the initial example with
myservice as service name.

ghost
ghost previously approved these changes Sep 6, 2018

@ghost ghost left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a useful change to me, in the context of the uses in the other parts of the file

@ghost

ghost commented Sep 6, 2018

Copy link
Copy Markdown

One minor thing I'm just noticing: the service class is named myservice above, but the option is --service Myservice - the text mentions something about this needing the first letter upper case, so that's probably correct. Just wanted to ask to be sure: is that case difference intentional?

@AndreMiras

Copy link
Copy Markdown
Member Author

Thanks for the review. Actually the option is --service=myservice:/path/to/myservice.py as stated in the current version of the document so name in the param is myservice. Then that gets "turned to" a dynamic class that way (pseudo Python code):

service = 'myservice' # comes from the `--service` param
f'Service{service.title()}' # then the dynamic class is the following -> ServiceMyservice

Not sure if it's clear?

@ghost

ghost commented Sep 6, 2018

Copy link
Copy Markdown

Ah. I think I was confused because I misread the text, I kind of thought I should specify --service again with the first letter uppercase. Maybe a minor change like this would work better:

Previously:

the name of the service is ServiceMyservice, in which Myservice is the identifier passed to the --service argument with the first letter upper case.

Suggestion:

the name of the service is ServiceMyservice, in which Myservice is the identifier that was previously passed to the --service argument, but with the first letter upper case.

But of course that's kind of unrelated to the change in the pull request, which is definitely an improvement in any case

It makes it easier to understand by using the initial example with
`myservice` as service name.
@AndreMiras AndreMiras force-pushed the feature/minor_service_doc_clarification branch from d4d7017 to 59b0061 Compare September 6, 2018 19:54
@AndreMiras

Copy link
Copy Markdown
Member Author

Thank you @Jonast I've adopted your suggestion 🍻

@inclement inclement merged commit 180fcec into kivy:master Sep 7, 2018
@AndreMiras AndreMiras deleted the feature/minor_service_doc_clarification branch February 1, 2019 12:28
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