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

Inline schemas docs #1456

Merged
merged 2 commits into from
Aug 14, 2022
Merged

Inline schemas docs #1456

merged 2 commits into from
Aug 14, 2022

Conversation

mlaily
Copy link
Contributor

@mlaily mlaily commented Aug 7, 2022

As a follow up PR for #1447, here is some documentation about the feature!

The branch is currently on top of the previous PR branch.
Please ignore all but the last two commits until the previous PR is merged and this one is rebased.

Note the TODO in the latest commit: I'm not sure which version will contain this new feature, so I left a version TBD that will have to be replaced before we merge the docs.

@cartermp
Copy link
Collaborator

cartermp commented Aug 8, 2022

@mlaily I merged the other one, could you rebase this please?

@mlaily mlaily force-pushed the inline-schemas-docs branch from 6915392 to c7412c8 Compare August 8, 2022 16:28
@mlaily
Copy link
Contributor Author

mlaily commented Aug 8, 2022

@cartermp done.

@mlaily
Copy link
Contributor Author

mlaily commented Aug 8, 2022

@cartermp but be careful not to merge this as-is: there is still a TODO to fix (replace a "version TBD" with the expected next version number)

@cartermp
Copy link
Collaborator

@mlaily there's a new version out - 4.2.10 - could you add that as appropriate here?

(also I now realize this could have been a 4.3 release, ah well)

mlaily added 2 commits August 13, 2022 16:03
- Fix some typos and formatting issues (notably, angle brackets need to be escaped or wrapped in back quotes for them not to be interpreted as html in the output)
- Try to clarify when runtime errors occur with the providers
- Document JSON comments support
@mlaily mlaily force-pushed the inline-schemas-docs branch from c7412c8 to 90885f3 Compare August 13, 2022 14:05
@mlaily
Copy link
Contributor Author

mlaily commented Aug 13, 2022

Ha, so much for semantic versioning! :D
(Hopefully, my care for backward compatibility was enough not to break anything in that regard...)

I replaced the version TBD with 4.2.10, updated the commit message, and rebased!

Thank you for your work :)

@cartermp
Copy link
Collaborator

We live dangerously.

@cartermp cartermp merged commit a6d11be into fsprojects:main Aug 14, 2022
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