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

Clean up documentation of new-er --report spec that include triggers, etc #469

Open
timsnyder opened this issue Feb 14, 2024 · 1 comment
Assignees
Labels
component: sparta Issue is related to sparta framework documentation Improvements or additions to documentation

Comments

@timsnyder
Copy link
Contributor

timsnyder commented Feb 14, 2024

oss << "Please refer to the files 'ReportTriggers.txt' and 'SubreportTriggers.txt'" << std::endl;
oss << "found in this directory for more information on how to specify these options" << std::endl;
oss << "from YAML files directly." << std::endl;

I recently ran into this error message. The in this directory part is really confusing. Should it point to the Sparta documentation somewhere instead?

Nope, the files to which it refers are in the CoreExample directory.

Not intuitive at all when one encounters this in the wild as a result of passing old arguments to an actual Sparta-based simulator that has nothing to do with the CoreExample.

What's worse is that the new hierarchical report specification seems to only be documented in those TXT files in the core example, it isn't included in the doxygen. Also, highly confusing.

@timsnyder timsnyder changed the title CommandLineSimulator throw_report_deprecated error message needs improvement Clean up documentation of new-er --report specifications that include triggers, etc Jun 14, 2024
@timsnyder timsnyder changed the title Clean up documentation of new-er --report specifications that include triggers, etc Clean up documentation of new-er --report spec that include triggers, etc Jun 14, 2024
@klingaard
Copy link
Member

Seems like an easy fix. Also, didn't know those files existed. Will do this:

  1. Move these files to sparta/doc/sparta_docs and remove dups
  2. Proof read and fix anything that's wrong.
  3. Connect it in with the existing documentation.

@klingaard klingaard self-assigned this Oct 6, 2024
@klingaard klingaard added documentation Improvements or additions to documentation component: sparta Issue is related to sparta framework labels Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: sparta Issue is related to sparta framework documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants