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

Improve section numbering #634

Merged
merged 1 commit into from Sep 20, 2022
Merged

Conversation

Ladicek
Copy link
Contributor

@Ladicek Ladicek commented Sep 19, 2022

CDI specification up to version 3.0 used to have the sections numbered in a friendly way:

  1. Architecture
  2. Concepts
  3. Programming model

And so on. With CDI 4.0 and the split to Lite and Full, sections were renumbered in a more ugly fashion:

  1. Architecture
  2. CDI Lite
    2.1. Concepts
    2.2. Programming model
  3. CDI Full

Note that this numbering is different from the TCK Audit tool expectations and hence the TCK Audit reports are incorrect.

This commit restores the original numbering, which is more user-friendly and also conforms to the expectations of the TCK Audit tool.

Copy link
Contributor

@manovotn manovotn left a comment

Choose a reason for hiding this comment

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

Just dropped one tiny comment, otherwise looks good.

spec/src/main/asciidoc/core/core_structure.adoc Outdated Show resolved Hide resolved
CDI specification up to version 3.0 used to have the sections numbered
in a friendly way:

1. Architecture
2. Concepts
3. Programming model

And so on. With CDI 4.0 and the split to Lite and Full, sections were
renumbered in a more ugly fashion:

1. Architecture
2. CDI Lite
2.1. Concepts
2.2. Programming model
3. CDI Full

Note that this numbering is different from the TCK Audit tool expectations
and hence the TCK Audit reports are incorrect.

This commit restores the original numbering, which is more user-friendly
and also conforms to the expectations of the TCK Audit tool.
@Ladicek Ladicek merged commit 8e69428 into jakartaee:master Sep 20, 2022
@Ladicek Ladicek deleted the section-numbering branch September 20, 2022 13:04
@Ladicek Ladicek added this to the CDI 4.1 milestone May 24, 2023
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