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

Correctly handle appendicies in md2html #3810

Merged
merged 1 commit into from
May 23, 2024
Merged

Conversation

handrews
Copy link
Member

We have an Appendix A that was getting treated as a numbered section, with a second Appendix A generated for references.

This now correctly detects sections with "Appendix" in the name, and assigns letters appropriately. The generated references section is now Appendix B (and will always be the last appendix).

We have an Appendix A that was getting treated as a numbered section,
with a second Appendix A generated for references.

This now correctly detects sections with "Appendix" in the name,
and assigns letters appropriately.  The generated references
section is now Appendix B (and will always be the last appendix).
@handrews handrews requested review from a team as code owners May 16, 2024 15:37
@ralfhandl
Copy link
Contributor

Nice!

This results in

image

which is almost what I'd expect: can we snip away the Appendix A: ?

@handrews
Copy link
Member Author

@ralfhandl let me see if I can figure out enough JavaScript for that 😅

@handrews
Copy link
Member Author

@ralfhandl it looks a bit weird to me without the "Appendix" because then the word "Appendix" doesn't appear anywhere.

oas-appendix

Ideally we would keep "Appendix A: " in the main text and leave it out of the TOC- that is what IETF RFCs do. But I don't know how to make that happen and don't have more time to spend on this. If you feel strongly about taking it out we can just go with bare letters, but out of the two not-great options I'd rather leave the redundancy in (it's not worse than what we current have) and hope someone can figure out a better solution later.

@lornajane
Copy link
Contributor

I'm sorry, I'm confused about how to preview the changes. I don't see Appendix B at all but I know we do some extra rendering. Am I just missing the docs on this?

@handrews
Copy link
Member Author

@lornajane

Am I just missing the docs on this?

Bold of you to assume we have docs! 🤪

I was lazy and did not publish a rendering, as you have to bounce between different branches to do it (at least until #3717 is fixed) but i should have. Here are three relevant samples (edit the URLs in the obvious ways to see other versions if you want):

Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@lornajane lornajane merged commit 3f2e047 into OAI:main May 23, 2024
2 checks passed
@handrews handrews deleted the appendix branch May 28, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants