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

Dismantling requirements tables 29-36 #6033

Open
tkoeppe opened this issue Dec 19, 2022 · 9 comments · May be fixed by #6941 or #6034
Open

Dismantling requirements tables 29-36 #6033

tkoeppe opened this issue Dec 19, 2022 · 9 comments · May be fixed by #6941 or #6034

Comments

@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 19, 2022

To convert the lib-intro requirements tables 29-36 into paragraphs, we don't currently have any section, and no good way to reference them.

Idea:

  1. A new subsection "16.4.4.?: Basic type requirements", after [16.4.4.2, utility.arg.requirements] and before [16.4.4.3, swappable.requirements].
  2. New nested subsections for each individual requirement, so that we can reference them individually (which is currently possible via the tables).

Thoughts?

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 19, 2022

@jensmaurer, @jwakely feedback welcome!

@Dani-Hub
Copy link
Member

Personally, I would strongly prefer to make each requirement individually referencable.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 19, 2022

@Dani-Hub Would it be sufficient to have a (very short) subsection for each requirement?

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 19, 2022

Maybe we don't need a new grouping subsection, but instead we can just put each requirement straight into its own level-3 subsection, so we'd have new subsections 16.4.4.3 -- 16.4.4.9.

@tkoeppe tkoeppe linked a pull request Dec 19, 2022 that will close this issue
@Dani-Hub
Copy link
Member

@Dani-Hub Would it be sufficient to have a (very short) subsection for each requirement?

Yes, sure, we don't need extraordinary overhead. It is just the thing that we want to refer to them individually.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 19, 2022

Note to selves: the fpos.requirements table should be quite easy to dismantle, too.

@Dani-Hub
Copy link
Member

Note to selves: the fpos.requirements table should be quite easy to dismantle, too.

I'm eagerly awaiting that.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Dec 19, 2022

@Dani-Hub PRs are of course always welcome :-)

@AlisdairM
Copy link
Contributor

AlisdairM commented Nov 9, 2023

I will be looking into this in the New Year (2024) if no-one beats me to it. It is annoying how often these requirements tables float into misleading subsections due to page breaking.

Feel free to "assign" me the ticket so I do not forget.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants