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

Add missing examples to LoE (list of examples) #418

Closed
neumannd opened this issue Dec 7, 2022 · 10 comments · Fixed by #450
Closed

Add missing examples to LoE (list of examples) #418

neumannd opened this issue Dec 7, 2022 · 10 comments · Fixed by #450
Labels
defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors

Comments

@neumannd
Copy link
Contributor

neumannd commented Dec 7, 2022

Title

Add missing examples to LoE (list of examples)

Moderator

@user

Requirement Summary

The list of examples (LoE) should contain all examples. Currently, it does not contain all examples.

Technical Proposal Summary

Add links to all examples to the LoE in toc-extra.adoc

Benefits

Examples can be found via the LoE

Status Quo

Several examples are missing in the LoE

Associated pull request

#450

Detailed Proposal

Several examples are missing in the LoE. The linked PR contains changes in the toc-extra.adoc which solve this (examples are added to LoE). Additionally, minor changes are implemented:

  • Example I.1 now has the caption "Example I.1"
  • caption "Examples 1.1. " was changes to "Example 2.1. " (because it is in chapter/section 2 and not in chapter/section 1)
  • changed "5.13." to "5.14." because a new examples 5.13 was inserted
  • appended a space to caption "Table D.1." => "Table D.1. "
  • added captions Table I.1. and Table I.1.
  • added a . to a caption in chapter 3

Note

Exmplae 8.7 was added to the LoE in this Issue (and PR !) but also in Issue #286 (PR #417). All other changes are only part of one of both issues/PRs.

@neumannd neumannd added the defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors label Dec 7, 2022
@neumannd neumannd changed the title Add missing examples to TOE (table of examples) Add missing examples to LoE (list of examples) Dec 7, 2022
@neumannd
Copy link
Contributor Author

Update to this issue: I had forgotten to add the related PR to the issue descrition. This was updated.

@neumannd
Copy link
Contributor Author

Might be decided in combination with #286 and #420

@JonathanGregory JonathanGregory linked a pull request Aug 28, 2023 that will close this issue
4 tasks
@JonathanGregory
Copy link
Contributor

Since this is a defect issue and no-one has objected to the corrections, I will merge the linked PR 419 at the same time as PR 417, which addresses issue 286. As discussed in that issue, the two pull requests affect some of the same areas and both are needed. Thanks, @neumannd.

@JonathanGregory
Copy link
Contributor

#419 now has conflicts to be resolved, because of #417 being merged. Please could you resolve them, @neumannd?

@neumannd
Copy link
Contributor Author

@JonathanGregory I'll do so. Just a few minutes.

@JonathanGregory
Copy link
Contributor

OK, fine. At the same time, perhaps you could modify the entries in history.adoc to mention that you've also corrected the titles of three tables, as well as the four examples. Many thanks.

@neumannd
Copy link
Contributor Author

@JonathanGregory I'll set a a new PR. Rebasing the old one causes many conflicts ... .

@neumannd
Copy link
Contributor Author

@JonathanGregory new PR is #450

@JonathanGregory JonathanGregory linked a pull request Aug 28, 2023 that will close this issue
4 tasks
@JonathanGregory
Copy link
Contributor

Very good - thanks. I'll merge it now.

@neumannd
Copy link
Contributor Author

Thanks for taking time and merging it 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants