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

Fix and refresh schema docs #976

Merged
merged 5 commits into from
Feb 29, 2024
Merged

Fix and refresh schema docs #976

merged 5 commits into from
Feb 29, 2024

Conversation

matentzn
Copy link
Contributor

@matentzn matentzn commented Jan 6, 2024

@hkir-dev this does not work perfectly anymore (the nesting does not work), see changes to schema_documentation.py.

This Commit extends the dump_schema() method in odk.py to allow dumping individual classes, rather than three classes concatenated.
This is now valid JSON file, previously it was three json files concatenated for no reason
This is not really a fix, but without it, schema_documentation.py throws an error when index('**') is called on a line without these symbols. This is acceptable because we need a better way for docs anyways, and no infromation is lost (looks a bit uglier though), cc @hkir-dev
A bit uglier then before, but still functional
@matentzn matentzn requested a review from hkir-dev January 6, 2024 17:01
@matentzn
Copy link
Contributor Author

@hkir-dev in case you did not see this yet - If I could get your recommendation on how to fix, I will gladly do it!

@matentzn matentzn added this to the 1.5 milestone Feb 24, 2024
@matentzn matentzn self-assigned this Feb 24, 2024
@hkir-dev
Copy link
Contributor

It appears that the recent update to jsonschema2md is the root cause of the issue. I've applied a bug fix, but I believe your expertise could help identify any lingering problems more efficiently, @matentzn. Could you please review and inform me of any remaining issues?

@matentzn matentzn merged commit 8f2fcb6 into master Feb 29, 2024
1 check passed
@matentzn matentzn deleted the fix-schema branch February 29, 2024 09:29
@matentzn
Copy link
Contributor Author

Thank you @hkir-dev for taking a look and adding a fix :) Looks ok for now, will cycle back on this later

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

Successfully merging this pull request may close these issues.

2 participants