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.

Sign up for GitHub

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

Jump to bottom

Improve descriptions in release schema #1303

Closed
wants to merge 30 commits into from
Closed

Improve descriptions in release schema #1303

wants to merge 30 commits into from

Conversation

ColinMaudry
Copy link
Member

Check descriptions in the release schema against the style guide.

@ColinMaudry ColinMaudry self-assigned this Jun 1, 2021
@ColinMaudry ColinMaudry marked this pull request as draft June 1, 2021 09:14
@ColinMaudry
It seems that 'the buyer' usually implies 'the buyer or procuring ent…
38c2bd4 
…ity' #850

e.g.: Contract.description
@ColinMaudry
See also the [Contract.]statusDetails field #850
7bfc8e7
@ColinMaudry
favour => favor (US English) #850
e81f830
@ColinMaudry
Make relatedProcesses description consistent, process => contracting …
07ecf31 
…process #850
@ColinMaudry
Make Implementation.description consistent with other Object.descript…
fbb5257 
…ion fields #850
@ColinMaudry
Make Implementation.milestones description consistent with other Obje…
115121b 
…ct.milestones descriptions #850
@ColinMaudry
Make Budget.id.description consistent with other id.description #850
ef8837b
@ColinMaudry
Uncamel case because not referring to the code #850
27f7fe9
@ColinMaudry
Clarify the description of Milestone.dateModified #850
327e7ec
@ColinMaudry
Remove reference to deprecation in Milestone.documents.description #850
1ed7f41
@ColinMaudry
Ran ocdskit schema-strict #850
815a5ca
@ColinMaudry
Ran util scripts
0270699
@ColinMaudry
Applied the .title .description field sequence #850
3675a84
@ColinMaudry
Make date description use either "The date..." or "The date on which.…
7f1dd85 
….." #850
@ColinMaudry
Shorter Budget.description #850
68e64fa
@ColinMaudry
Removed '(if applicable)' from descriptions #850
5c4e45a
@ColinMaudry
Rephrase Transaction.id.description #850
8024d3d
@ColinMaudry
Commas in enumerations #850
6f13b34
@ColinMaudry
Remove '(Depreacted in 1.1)' from Budget.source.description #850
b43e4b7
@ColinMaudry
Ran util scripts
a711f1f
@ColinMaudry ColinMaudry linked an issue Jun 11, 2021 that may be closed by this pull request
Adopt consistent style in field and code descriptions #850
Open
3 tasks
@ColinMaudry
Copy link
Member Author

@jpmckinney This PR is a first attempt at normalizing schema field descriptions, applying the style guide consistently. Is it going in the right direction? Thanks!

@ColinMaudry ColinMaudry marked this pull request as ready for review June 17, 2021 12:00
@ColinMaudry
Copy link
Member Author

@jpmckinney Ready for review! :)

@jpmckinney jpmckinney added this to the 1.2.0 milestone Jul 31, 2021
This was referenced Sep 2, 2021
Closed
Closed
@jpmckinney
Copy link
Member

This issue has many conflicts, since various other PRs end up changing one or two fields. I think it might be better to draft changes in a document (allowing comments and suggested edits – I don't think Google Sheets yet has this functionality), which we then transfer to a PR. Otherwise, it will be very long and confusing to resolve conflicts.

@odscjen odscjen mentioned this pull request Jul 18, 2022
Open
3 tasks
@ColinMaudry ColinMaudry closed this Apr 1, 2023
@jpmckinney jpmckinney deleted the 850_improveDescriptions branch April 3, 2023 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpmckinney jpmckinney jpmckinney left review comments

Assignees

@ColinMaudry ColinMaudry

Labels
None yet
Projects
OCDS 1.2
Status: Done
Milestone
1.2.0
Development

Successfully merging this pull request may close these issues.

Adopt consistent style in field and code descriptions
3 participants
@ColinMaudry @jpmckinney @JachymHercher