Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

[sphinx extension] Source for Description - currently msg for val/trans #114

Open
lars-petter-hauge opened this issue Jan 23, 2020 · 0 comments

Comments

@lars-petter-hauge
Copy link
Contributor

For the user of configsuite, I don't think it's obvious that the msg added to the decorators is what will inform the user in the documentation about what is going on. Also, I feel this splits the information about what is going into the documentation quite significantly. All the descriptions are already within the schema dict, the names, required/default/alllownone etc. - and then you would have to go to the function declaration in order to edit documentation regarding transformations/validations..

And those msg looks to be one-liners, while transformations and validations, especially context based ones, could probably need more than that

Let's think about it a bit at least..

Originally posted by @lars-petter-hauge in #80

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant