refine echoinput messages and errors in Q_setup

nmfs-ost / ss3-source-code

The source code for Stock Synthesis (SS3).

https://nmfs-ost.github.io/ss3-website/

Creative Commons Zero v1.0 Universal

38 stars 16 forks source link

refine echoinput messages and errors in Q_setup #582

Closed iantaylor-NOAA closed 8 months ago

iantaylor-NOAA commented 8 months ago

Concisely describe what has been changed/addressed in the pull request.

Refines echoinput messages and errors associated with read of Q_setup in control file inspired by recent forums post by Laura Lee: https://vlab.noaa.gov/web/stock-synthesis/public-forums/-/message_boards/message/35975358.

makes more clear which fleet has an issue in Q setup
aligns notation (now just "Q setup" instead of also "q setup" and "Qsetup")
adds explanation for why the echoed Q setup table looks different than input
adds explanation for Q_Npar and Q_Npar2

What tests have been done?

Where are the relevant files?

Files attached to forums messages were used for testing.

What tests/review still need to be done?

Make sure the refinements make sense.

Is there an input change for users to Stock Synthesis?

[x] No, there was no input change.

Rick-Methot-NOAA commented 8 months ago

I am not aware of any past discussion on the need for consistency with regard to punctuation at the end of such lines in the output

e-perl-NOAA commented 8 months ago

Okay, great! Those were just questions I had based on not having a firm knowledge of C++ and if things of that sort would cause issues down the road.

Rick-Methot-NOAA commented 8 months ago

Ahh. I see that you were referring to the C++ structure. A line not ending with ; is just continued to the next line.

iantaylor-NOAA commented 8 months ago

@e-perl-NOAA I didn't even think about the semi colons, so good question.

I was unconsciously following the style added by the automated code-styling Neil applied in 2022 (discussed in https://github.com/nmfs-ost/ss3-source-code/issues/163), which added lines breaks after every endl. For instance, commit 6252695 converting things like

SS2out<<endl<<"Starter_Comments"<<endl<<Starter_Comments<<endl;

    SS2out << endl
           << "Starter_Comments" << endl
           << Starter_Comments << endl;

There's still just the one semi-colon at the end, but line breaks within it to improve readability. That code is equivalent to this version with 3 semi-colons:

    SS2out << endl;
    SS2out << "Starter_Comments" << endl;
    SS2out << Starter_Comments << endl;