search

HenningHolmDE / hcloud-rust

Unofficial Rust crate for accessing the Hetzner Cloud API
Other
66 stars 6 forks source link

How to add documentation to the generated code? #6

Open HenningHolmDE opened 4 years ago

HenningHolmDE commented 4 years ago

Find a nice way for adding additional documentation to the generated code (without changing the generated files directly).

First idea: Adding documentation from a separate description file (e.g. JSON/YAML) using a post-processsing script when generating the code.

good-praxis commented 2 years ago

I was gonna have a look at this, but I can't get the code generation to work; Do you think you could add the generating command (and maybe version spec?) to the README.md?

I have since found the scripts, but that might be worth pointing out int he README regardless

HenningHolmDE commented 2 years ago

Glad you finally found the scripts! Good point, I should definitely add a note about that to the README.