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

Default id to "Read-Only" + allow for empty blocks/nested attributes to be documented #134

Merged
merged 5 commits into from May 3, 2022

Conversation

detro
Copy link
Contributor

@detro detro commented May 3, 2022

Closes #46
Closes #99

This PR is a cherry-pick-like one: there are key fixes we want to land in v0.8.0, and given PRs have been open for a long while, we want to support them without additional burden to the original contributors.
Of course, authorship is preserved.

See the linked content for more context about each fix.

Big thank you to: @ovandriyanov, @nmuesch, @OJFord

ovandriyanov and others added 3 commits Apr 29, 2022
This still allows arbitrary definition of `id` where a tailor-made `.Description` can be provided: it's just the default that is changing to something more sensible.

Also, updated README to guide developers.

Co-authored-by: Nicholas Muesch <nicholas.muesch@datadoghq.com>
Co-authored-by: Oliver Ford <dev.github@ojford.com>
@detro detro requested a review from as a code owner May 3, 2022
@detro detro added this to the v0.8.0 milestone May 3, 2022
@detro detro added this to the v0.8.0 milestone May 3, 2022
@detro detro added this to the v0.8.0 milestone May 3, 2022
@detro detro added this to the v0.8.0 milestone May 3, 2022
@detro detro changed the title [WIP] 0.8.0 Default id to "Read-Only" + allow for empty blocks/nested attributes to be documented May 3, 2022
Copy link
Contributor

@bendbennett bendbennett left a comment

LGTM

bflad
bflad approved these changes May 3, 2022
Copy link
Member

@bflad bflad left a comment

Looks good to me 🚀

@detro detro merged commit 16993bf into main May 3, 2022
4 checks passed
@detro detro deleted the detro/0.8.0 branch May 3, 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.

None yet

4 participants