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

Doc: The definitions are expressed as a table. #1452

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yoshihiro503
Copy link
Contributor

Motivation for this change

Source code looks:

Screenshot from 2025-01-10 13-17-27

Html doc looks:
Screenshot from 2025-01-10 13-17-46

Checklist
  • added corresponding entries in CHANGELOG_UNRELEASED.md
  • added corresponding documentation in the headers

Reference: How to document

Reminder to reviewers

@proux01
Copy link
Collaborator

proux01 commented Jan 10, 2025

I'm lost, didn't we said that bullet lists would be easier to use?
Otherwise, for what it's worth, as far as I remember, if we want to save characters, the last | at the end of the line is not mandatory (as well as the space before the first one).

@affeldt-aist
Copy link
Member

I'm lost, didn't we said that bullet lists would be easier to use?

Yes, but also that we should try to use tables when reasonable.

@proux01
Copy link
Collaborator

proux01 commented Jan 10, 2025

Did we converge on some "definition" of reasonable?

@affeldt-aist
Copy link
Member

Did we converge on some "definition" of reasonable?

I think that "unreasonable" was implicitly defined as "when formatting is too painful because there are many RHS that require several lines each"

@affeldt-aist
Copy link
Member

Mmmhhh, I am concerned by the fact that the source file is much less readable.
In https://github.com/math-comp/analysis/blob/master/classical/classical_sets.v, we only used a table to format a summary of the documentation, and then providing the full documentation in verbatim centered lists (this was really just a test).
What about doing the same here? (LaTeXified digest at the top, and full doc in ASCII.)

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.

3 participants