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

Update documentation #1316

Merged
merged 10 commits into from
May 13, 2023
Merged

Update documentation #1316

merged 10 commits into from
May 13, 2023

Conversation

noddycode
Copy link
Contributor

This PR seeks to update the documentation for this project with the following changes:

  • Small fixes to spelling and grammar
  • Standardizing the formatting of sample file names
  • Fixing heading levels and formatting where appropriate
  • Changing phrasing in certain places for clarity and flow
  • Standardization of the casing and spacing of "JSON" and "JSON Schema"
  • Title casing page headers
  • Removing redundant data and adding links where appropriate
  • Updating broken links
  • Syncing changes between the Index page and the readme

This is my first PR to a public project, please alert me to any needed or suggested changes.

### DataType
- string (include patter/minLength/maxLenght)
- number (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
- integer (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
Copy link
Contributor Author

@noddycode noddycode May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were removed as I could not find any reference to le/ge in the OpenAPI or JSON Schema docs

@codecov
Copy link

codecov bot commented May 13, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (e9b6edf) 100.00% compared to head (90de1d7) 100.00%.

Additional details and impacted files
@@             Coverage Diff             @@
##            master     #1316     +/-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files           11        25     +14     
  Lines         1020      3259   +2239     
  Branches       201       780    +579     
===========================================
+ Hits          1020      3259   +2239     
Flag Coverage Δ
unittests 99.93% <99.92%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
datamodel_code_generator/__init__.py 100.00% <100.00%> (ø)
datamodel_code_generator/__main__.py 100.00% <100.00%> (ø)
datamodel_code_generator/format.py 100.00% <100.00%> (ø)
datamodel_code_generator/http.py 100.00% <100.00%> (ø)
datamodel_code_generator/imports.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/__init__.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/base.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/dataclass.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/enum.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/improts.py 100.00% <100.00%> (ø)
... and 15 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@koxudaxi koxudaxi merged commit 2db3745 into koxudaxi:master May 13, 2023
43 checks passed
@noddycode noddycode deleted the add-documentation branch May 13, 2023 11:40
@koxudaxi
Copy link
Owner

koxudaxi commented Jun 6, 2023

@noddycode
I forgot to say thank you.
Thank you for improving the documents 🙇

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.

None yet

2 participants