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

Document non-standard file prefixes in implementation-notes.md. #198

Closed
pixelzoom opened this issue Feb 27, 2024 · 1 comment
Closed

Document non-standard file prefixes in implementation-notes.md. #198

pixelzoom opened this issue Feb 27, 2024 · 1 comment
Assignees

Comments

@pixelzoom
Copy link
Contributor

Related to code review #32 ...

From the CRC:

  • Do filenames use an appropriate prefix? ...

There are a number of files with "VSM" and "SM" prefixes. Non-standard prefixes should be documented somewhere, implemenation-notes.md looks like the intended place, but it's incomplete -- it identifies "VSM" but not "SM". I'm not sure if there are other such prefixes, because I'm partway through the review.

If you decide to keep common-vsm and common-sm in #197, you might also say something about them in implemenation-notes.md (correspondence to "VSM" and "SM", what value they are providing, etc.)

@matthew-blackman
Copy link
Contributor

The commit looks good to me and adds the appropriate amount of documentation. Nice work! Closing.

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

No branches or pull requests

3 participants