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

Documentation cross-reference and table improvements #83

Open
3 tasks
cefect opened this issue Mar 23, 2023 · 1 comment
Open
3 tasks

Documentation cross-reference and table improvements #83

cefect opened this issue Mar 23, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cefect
Copy link
Collaborator

cefect commented Mar 23, 2023

We're using some pretty difficult syntax and features... not your fault... and largely owing to having to port from MS word a few years ago.

I added a ./docs/CONTRIBUTING.md with some ideas how we can improve the document and workflow. Specifically to the number of tables (and figures) this means using the 'numref' role to automatically number things (so we don't have to renumber the whole section anytime something changes. Similarly, I noticed many of the cross-references have weird spacing (e.g., FIgure1-2 instead of Figure 1-2). Finally, many of the tables are unreadable owing to excessive column widths (e.g., the Table "CanFlood model level summaries").

The following should be addressed per the new CONTRIBUTING.md guidelines:

  • revise all figure and table references to use the 'numref' roll (rather than manually number). Not all figures need a number. We may lose the section number, but this is fine.
  • revise all cross-references to be human readable e.g. Table1.1 should be revised to Table 1.1 (numref will automatically do this for tables and figures, but sections may need to be cleaned manually).
  • check the width of the tables. Any that are unreadably long should be converted to a csv-table to get the text to wrap.
@cefect cefect added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 23, 2023
@cefect
Copy link
Collaborator Author

cefect commented Mar 23, 2023

For re-building tables, it may be easier to use the original manual .docx which is here.

@GrahamD-IBI GrahamD-IBI assigned VLai899 and unassigned GrahamD-IBI Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants