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

Ensure ##NEW convention is consistent throughout #9

Open
Bergam0t opened this issue Apr 17, 2024 · 1 comment
Open

Ensure ##NEW convention is consistent throughout #9

Bergam0t opened this issue Apr 17, 2024 · 1 comment
Assignees
Labels
editing Tasks relating to consistency and clarity of the text and structure of the book

Comments

@Bergam0t
Copy link
Collaborator

New code has been identified with ##NEW throughout in code snippets (in line with how it's done in lectures and code examples this is based off).

Need to check for spacing and consistency of double # throughout to ensure it's easy to find the code additions, rather than a mix of #NEW, # NEW, ##NEW and ## NEW that I think has crept in.

@Bergam0t Bergam0t added the editing Tasks relating to consistency and clarity of the text and structure of the book label Apr 17, 2024
@Bergam0t Bergam0t self-assigned this Apr 17, 2024
@amyheather
Copy link

amyheather commented May 2, 2024

Uses old format of indicators:

  • 15.2 - a few examples of "## NEW" and "##MODIFIED"
  • 15.3 - a few examples of "# NEW", "## NEW", and "##MODIFIED"
  • 17.2.1.3.2 - "##EDITED"
  • 23.2.3 - a few examples of "## NEW"

Missing a new indicator:

  • 15.2.5 - does this need a "##NEW"?
  • 17.2.1.2.2 - does this need a "##NEW"? (appreciate it says that its a new method, but if someone if looking at whole code and doing Ctrl+F to find new sections would probably be handy)
  • 23.2 - missing "##NEW" for some sections (e.g. g, Patient)
  • 23.2.5.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editing Tasks relating to consistency and clarity of the text and structure of the book
Projects
None yet
Development

No branches or pull requests

2 participants