Update docs #24
Update docs #24
Conversation
Add cli doc for recent change , cross-language-cpp#14 / cross-language-cpp#22 Check that docs for cross-language-cpp#20 / cross-language-cpp#21 is in place Improve Identifyer Style section
|
I wonder if there is a way to preview the docs local, especially when playing around with mkdocs specials, like the |
I've used Python mkdocs locally before on a project. That project was hosted on a local Gitlab instance (not github) so I spent some time ensuring my MarkDown was compatible and rendered as intended with both the Gitlab and mkdocs rendering. |
|
you can preview the docs by running The admonition blocks ( I opened an issue to improve the preview-ability in each repository. Thanks for your feedback, @a4z |
| ``` | ||
| As you see, _VALUE_ is now in upper case letters. | ||
|
|
||
| If you use `--ident-java-enum foo_bar` then _Value_ will not be transformed into upper case and the following Java code will be generated. |
There was a problem hiding this comment.
This is so weird 🙈
If changing the Identifier names would not potentially break so many builds I'd prefer more speaking names for them:
camelCaseTrainCasesnake_casenone<== This is whatfoo_barcurrently is.- ...
There was a problem hiding this comment.
What do you think about renaming them? This just came to my mind a few days ago. I don't see it in the scope of this PR.
There was a problem hiding this comment.
might still be a breaking change.
we could add none as a keyword to start a smooth transition process ....
There was a problem hiding this comment.
just want to talk with you about this on a theoretical basis. :P I'm aware that this is a major breaking change.
Co-authored-by: jothepro <[email protected]>
Co-authored-by: jothepro <[email protected]>
Add cli doc for recent change , #14 / #22
Check that docs for #20 / #21 is in place
Improve Identifyer Style section , for #11