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

generic text for CAAL and why they are used #59

Open
kellijohnson-NOAA opened this issue Nov 12, 2021 · 0 comments
Open

generic text for CAAL and why they are used #59

kellijohnson-NOAA opened this issue Nov 12, 2021 · 0 comments
Assignees
Labels
status --- ❔ further information is currently being requested topic --- default text text stored in the package used to automatically populate sections type --- feature feature requests and enhancement

Comments

@kellijohnson-NOAA
Copy link
Contributor

Problem

Many versions of text explaining why we use CAAL data exist and have been used in various stock assessments, which makes it hard to maintain and also not consistent across documents.

Proposal

Create generic text that can be included in a document, complete with references, for those using CAAL data. This can be called in a single time in a consistent place within the documents. Although, where it is put could be up to the author.

🥒

  • account for species name being specific, we could make this a function or a template, I am not really sure, but the method here should be carried forward to other text that we want to include that is generic.
  • Should not be in every section with CAAL just once at the beginning of the data section.
  • Do we want this to look at the model files and see if CAAL data were used and add the appropriate text?
@kellijohnson-NOAA kellijohnson-NOAA added type --- feature feature requests and enhancement status --- ❔ further information is currently being requested topic --- default text text stored in the package used to automatically populate sections labels Nov 12, 2021
@kellijohnson-NOAA kellijohnson-NOAA self-assigned this Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status --- ❔ further information is currently being requested topic --- default text text stored in the package used to automatically populate sections type --- feature feature requests and enhancement
Projects
None yet
Development

No branches or pull requests

1 participant