Implement documentation user reviews
1 unresolved thread
1 unresolved thread
This MR tracks and implements the user reviews for the VAPython documentation.
Merge request reports
Activity
added documentation enhancement labels
assigned to @pascal.palenda
requested review from @pascal.palenda
assigned to @schaefer
8 9 ## Prototyping 10 11 VA interfaces make use of prototyping methods. Instead of using a fixed set of input variables, 12 these expect a dictionary with any set of parameters. Such methods can be "extended" by internally 13 allowing for new parameters making it easier to maintain backwards compatibility of the VA interfaces. 14 Also this allows setting a large set of parameters with a single function call. Prototyping methods usually 15 have names similar to `va.set_..._parameters()` or `va.get_..._parameters()`. 16 Nevertheless, also variable-based methods are provided for the most common use-cases and should preferably be used. 17 18 **Example** 19 ```python 20 # Both of the following calls will create a directivity from a file with name "fig-8" 21 D = va.create_directivity_from_file("path/to/file.daff"), "fig-8") 22 D = va.create_directivity_from_parameters("fig-8", {"filepath": "path/to/file.daff"}) 23 ``` changed this line in version 3 of the diff
- Resolved by Philipp Schäfer
- Resolved by Philipp Schäfer
Thank you for adapting this. Just some minor formatting things.
The comment with the prototyping only gets relevant once we merge VAWebsite!12
reset approvals from @pascal.palenda by pushing to the branch
added 1 commit
- 0dd17f49 - Docs: reduced prototyping section and referred to VAWebsite instead
mentioned in commit 85ef6013
Please register or sign in to reply