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

Add exported profiles "legend" #239

Open
1 task done
Carsopre opened this issue Dec 17, 2024 · 0 comments
Open
1 task done

Add exported profiles "legend" #239

Carsopre opened this issue Dec 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone

Comments

@Carsopre
Copy link
Collaborator

Carsopre commented Dec 17, 2024

Koswat version checks

  • I have checked that the issue still exists on the latest version of the docs in master here.

Kind of issue

Documentation is missing

Location of the documentation

/docs/reference

  • Probably is better to have a new chapter koswat_plots.
  • Create subsections for base_profile and reinforced_profile.

Documentation problem

We do not have anywhere in the documentation a description on what each of the exported plots represent and how to interpret them.

Suggested fix for documentation

Describe in the documentation which line (and color) represents the base profile, which the reinforced one, and so on.
If required modified the code so that said colors are normalized.

So far:

  • blue lines = base profile
  • red lines = reinforced profile
  • black lines = new surface layer
@Carsopre Carsopre added documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone labels Dec 17, 2024
@Carsopre Carsopre added this to the Sprint 2024.4.5 milestone Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant