website icon indicating copy to clipboard operation
website copied to clipboard

Change format keyword positioning

Open bhavukkalra opened this issue 2 years ago • 2 comments

What kind of change does this PR introduce? PR moves the format section of the documentation from the misplaced string page to under the more generic type as discussed in Issue #759. Which aims to remove the Misinterpretation that the reader might get that format as a keyword is only for string types which is not the case.

Also, Add further clarification that format as a keyword is generic. Using these lines added further

image

Issue Number:

  • Closes #187

Screenshots

  • Added section under type page

image

  • removed from format section from string page

image

Summary PR aims to re-adjust the positioning of format keyword definitions. To remove any confusion of it being a string specific keyword as reported by the users here Slack Archives

Does this PR introduce a breaking change? No

CC - @benjagm @gregsdennis @jviotti

bhavukkalra avatar Apr 18 '24 12:04 bhavukkalra

misplaced string page to under the more generic type as discussed in https://github.com/json-schema-org/json-schema-spec/issues/759

I checked the issue https://github.com/json-schema-org/json-schema-spec/issues/759 and it was closed 2019. Are you sure you are referring to the right issue?

benjagm avatar Apr 23 '24 08:04 benjagm

Hello, I followed the Microsoft style guide for technical writing to review the content. My only concern is formatting the code snippets. If you are fixing the code snippet indentation here, It would help if you also fixed the indentation across the entire documentation.

kakabisht avatar May 04 '24 07:05 kakabisht

Hello! :wave:

This pull request has been automatically marked as stale due to inactivity :sleeping:

It will be closed in 180 days if no further activity occurs. To keep it active, please add a comment with more details.

There can be many reasons why a specific pull request has no activity. The most probable cause is a lack of time, not a lack of interest.

Let us figure out together how to push this pull request forward. Connect with us through our slack channel : https://json-schema.org/slack

Thank you for your patience :heart:

github-actions[bot] avatar Jun 23 '24 00:06 github-actions[bot]

This issue is going to be closed due to inactivity.

benjagm avatar Jul 24 '24 07:07 benjagm