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

Depricate PvlObject classes addLogGroup function #5310

Open
acpaquette opened this issue Oct 12, 2023 · 1 comment
Open

Depricate PvlObject classes addLogGroup function #5310

acpaquette opened this issue Oct 12, 2023 · 1 comment
Labels
breaking API breaking change

Comments

@acpaquette
Copy link
Collaborator

acpaquette commented Oct 12, 2023

Given the current ISIS core work, there is a coupling between PvlObject and the Application class. Where the PvlObject accesses the Application static function Log to place output into an applications terminal.

This is a poor coupling and should be up to the Application class to log data to the application terminal and add any relevant PVL data to a Pvl object.

Ideally, we would deprecate the PvlObject function addLogGroup for a new function on to Application called something like appendAndLog, with two inputs the PvlGroup to log and the output Pvl object. Where it would log to the application terminal and if a Pvl object were passed in, add the results group to the Pvl object.

Function signature

appendAndLog(PvlGroup &results, Pvl &log)
@acpaquette acpaquette added the breaking API breaking change label Oct 12, 2023
@antonhibl antonhibl self-assigned this Nov 21, 2023
@acpaquette acpaquette changed the title Depricate PvlObject classes appendLogGroup function Depricate PvlObject classes addLogGroup function Nov 22, 2023
@antonhibl
Copy link
Contributor

@acpaquette is this closeable? #5347 seems to add the depreciation notice, is there a set date we will be depreciating the function completely by?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking API breaking change
Projects
Status: On Hold
Development

No branches or pull requests

2 participants