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

Inherited title not shown if description present #18

Closed
tcharding opened this issue Oct 27, 2023 · 2 comments
Closed

Inherited title not shown if description present #18

tcharding opened this issue Oct 27, 2023 · 2 comments

Comments

@tcharding
Copy link

tcharding commented Oct 27, 2023

Multiple patches which all inherit title gives:

============================================

## Development

Internal development changes

* Add tfile

* Check for changes to the public API

* Make commits conform to mkchlog format

============================================

If we change the second patch to use description: the title gets dropped

============================================

## Development

Internal development changes

* Add tfile

Generate the full public API as a set of text files and commit them to the repository, for each subsequent PR do the same and check that the final state of the pubic API is not different. Implies that changing the public API requires a patch to the committed API text files.

* Make commits conform to mkchlog format

============================================

And if we add a title then we get a new subsection which breaks the list

============================================

## Development

Internal development changes

* Add tfile

### Check for changes to public API in CI

Generate the full public API as a set of text files and commit them to the repository, for each subsequent PR do the same and check that the final state of the pubic API is not different. Implies that changing the public API requires a patch to the committed API text files.

* Make commits conform to mkchlog format

============================================

Expected behaviour

I was expecting to be able to inherit the title and get

============================================

## Development

Internal development changes

* Add tfile

* Check for changes to public API

   Generate the full public API as a set of text files and commit them to the repository, for each subsequent PR do the same and check that the final state of the pubic API is not different. Implies that changing the public API requires a patch to the committed API text files.

* Make commits conform to mkchlog format

============================================

or use a new title and get it as part of the list

============================================

## Development

Internal development changes

* Add tfile

* Check for changes to public API in CI

   Generate the full public API as a set of text files and commit them to the repository, for each subsequent PR do the same and check that the final state of the pubic API is not different. Implies that changing the public API requires a patch to the committed API text files.

* Make commits conform to mkchlog format

============================================
@tcharding
Copy link
Author

FTR I did not render the markdown, I just guessed at what it should be.

@crywolf
Copy link
Owner

crywolf commented Oct 27, 2023

Thank you.

@crywolf crywolf closed this as completed Oct 27, 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

No branches or pull requests

2 participants