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

Documentation #324

Open
HorridModz opened this issue Aug 24, 2024 · 2 comments
Open

Documentation #324

HorridModz opened this issue Aug 24, 2024 · 2 comments

Comments

@HorridModz
Copy link

Other than the README, is there any further documentation for Schema? I'm having much difficulty using it to validate arguments for a command line application, as I'm trying to do a lot of complex operations and I keep running into problems. I can see how powerful this tool can be, but using it is so tedious as I'm forced to read through the code, look at examples from random code snippets, and write weird code when there must be better ways to achieve things. Any other resources that I could use would be tremendous, if they exist.

@mutricyl
Copy link

You can have a look to the test file for examples.

Do you have an example of "weird" code or schemas that you are not happy with ?

@HorridModz
Copy link
Author

You can have a look to the test file for examples.

Do you have an example of "weird" code or schemas that you are not happy with ?

Thanks for sharing the test file, though it's not really what I'm looking for - seeing the test cases doesn't really help reveal what things do and what they are for, and it's also tedious and difficult; I might as well just read the code itself. Having a proper documentation (such as Read the Docs) is really helpful for modules like this, and personally, it's the first resource I always look for. In my opinion, a more formal documentation (even if rushed and/or brief) would go a very long way; however, it is of course a lot of work and there's no obligation for it to exist. I know that it's a big ask, but as this repo is at almost 3k stars, I'm sure I'm not the only one who would benefit from it.
Please excuse any harshness, and I don't mean to condescend - I'm just stating how I see it from my perspective as an end user.

I don't have any specific examples of clunky code at the moment, as I keep discovering more and revising my code. Since writing this comment, I have found solutions to many of the problems I was running into and I'm much happier with my code. I'm not complaining about the module itself, and I don't need any burning help with anything. My point is that figuring out how to properly use Schema and getting comfortable with it would have been much easier with some more references / documentation, as opposed to digging into the code / uncovering and reading obscure code snippets.

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

2 participants