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

Add note to the Proto file structure guide #8

Open
alexander-yevsyukov opened this issue Mar 9, 2020 · 0 comments
Open

Add note to the Proto file structure guide #8

alexander-yevsyukov opened this issue Mar 9, 2020 · 0 comments

Comments

@alexander-yevsyukov
Copy link
Contributor

We used to have this note in the “Naming Conventions” document in the “Introduction” section:

<p class="note">We recommend using the `java_outer_classname` option in proto files to make
    the name of the corresponding Java outer class obvious.
    Otherwise Protobuf Compiler tries to use the name of the file for
    the Java class. For example, for `identifiers.proto` it will be `Identifiers.java`.
    Though sometimes it can be `SomethingOuterClass` when there is a type which conflicts with
    the CamelCase version of the file name. You may also want to use names like `Identifiers` for
    utility classes related to your domain.</p>

It is too early to speak about these matters in the Introduction section. These are too fine details.

@alexander-yevsyukov alexander-yevsyukov transferred this issue from SpineEventEngine/SpineEventEngine.github.io Jan 12, 2022
JuliaEvseeva pushed a commit that referenced this issue Jan 26, 2022
…Add more details to README #8 PR.

Formatting applied, writing style adjusted.
JuliaEvseeva pushed a commit that referenced this issue Jan 26, 2022
…Add more details to README #8 PR.

Removed a note following reviewer's suggestion.
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

No branches or pull requests

1 participant