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

Asciidoctor: Remaining change admonishments #573

Merged
merged 3 commits into from
Feb 7, 2019
Merged

Asciidoctor: Remaining change admonishments #573

merged 3 commits into from
Feb 7, 2019

Conversation

nik9000
Copy link
Member

@nik9000 nik9000 commented Feb 4, 2019

Adds support for coming and deprecated which function very similarly
to added.

@nik9000
Asciidoctor: Remaining change admonishments
1dc7300 
Adds support for `coming` and `deprecated` which function very similarly
to `added`.
@nik9000 nik9000 requested a review from ddillinger February 4, 2019 19:54
@nik9000 nik9000 mentioned this pull request Feb 4, 2019
Closed
ddillinger
ddillinger reviewed Feb 7, 2019
View reviewed changes
Copy link

@ddillinger ddillinger left a comment

Choose a reason for hiding this comment

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

This actual change looks fine to me, however I did leave some comments about a couple of things I felt were worth clarifying first.

resources/asciidoctor/lib/elastic_compat_preprocessor/extension.rb Outdated
@@ -7,15 +7,23 @@
#
# Turns
# added[6.0.0-beta1]
# changed[6.0.0-beta1]
Copy link

Choose a reason for hiding this comment

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

The code and comments disagree, the code says coming but the comments say changed

Copy link
Member Author

Choose a reason for hiding this comment

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

I've pushed a fix!

resources/asciidoctor/lib/change_admonishment/extension.rb
[
[:added, 'added'],
[:coming, 'changed'],
[:deprecated, 'deleted'],
Copy link

Choose a reason for hiding this comment

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

One of these things is not like the others! I'm sure there is a reason BUT, to people (like me!) reading this, the word deprecated absolutely does not mean the same thing as deleted, in fact it very specifically implies "definitely totally 100% still present".

Is this dictated by the docbook side? I see from the tests that the revisionFlag will contain deleted. If that is within our control it may be worth its own issue? I have no clear sense of how much inertia there is behind it either.

Copy link
Member Author

Choose a reason for hiding this comment

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

It is dictated by the docbook side, yeah. I'll file an issue for it! I think it is a thing that we can clean up now, but I'd like to break it into its own thing.

Copy link
Member Author

Choose a reason for hiding this comment

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

#588

@nik9000 nik9000 merged commit 44f428e into elastic:master Feb 7, 2019
@nik9000
Copy link
Member Author

nik9000 commented Feb 7, 2019

Thanks for reviewing @ddillinger!

nik9000 added a commit that referenced this pull request Feb 15, 2019
@nik9000
Asciidoctor: Remaining change admonishments (#573)
f0070da 
Adds support for `coming` and `deprecated` which function very similarly
to `added`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ddillinger ddillinger ddillinger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nik9000 @ddillinger