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

Refactor _Advanced Usage_ section in the doc and correct errors therein #156

Closed
8 tasks done
lelaus opened this issue Mar 9, 2024 · 7 comments
Closed
8 tasks done
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lelaus
Copy link
Collaborator

lelaus commented Mar 9, 2024

This issue is related to the tasks of Advanced Usage section in #147.

  • put the paragraph related to the available_correlations() example outside the bulleted list;
  • transform the two bullets into two subsections;
  • typo: from "Let" to "Let's"
  • pass separator in different OS (already treated in Checking separator when calling set_custom_properties_path() method #153)
  • focus on listing only the relevant correlations, that is the ones available for rho
  • modify Lead.correlations_available() into Lead.available_correlations()
  • "If the density correlation is not specified for a new object instantiation, the last one in the list will be selected as default:": currently, the example below shows only what happens by using the Lead.set_correlation_to_use(); an example should be added showing the default behavior as noted here if the function Lead.set_correlation_to_use() is not used
  • modify the path <execution_dir>/custom_property into <execution_dir>/custom_properties.
@lelaus lelaus added the documentation Improvements or additions to documentation label Mar 9, 2024
@lelaus lelaus self-assigned this Mar 9, 2024
@lelaus
Copy link
Collaborator Author

lelaus commented Mar 22, 2024

Task n.6 treated in #144.

lelaus added a commit that referenced this issue Mar 24, 2024
…elations explanation outside from bulleted list in advanced usage chapter
@lelaus
Copy link
Collaborator Author

lelaus commented Mar 24, 2024

Task n. 1 handled in 1e77498.

lelaus added a commit that referenced this issue Mar 24, 2024
@lelaus
Copy link
Collaborator Author

lelaus commented Mar 24, 2024

Task n.2 handled in 31c3cca.

@lelaus
Copy link
Collaborator Author

lelaus commented Mar 24, 2024

Task n.5 handled in 7454d24.

lelaus added a commit that referenced this issue Mar 24, 2024
@lelaus
Copy link
Collaborator Author

lelaus commented Mar 24, 2024

Task n.8 handled in c133269.

lelaus added a commit that referenced this issue Mar 24, 2024
…ault correlation choice when adding new correlation
@lelaus
Copy link
Collaborator Author

lelaus commented Mar 24, 2024

Task n.7 handled in 341a185.

lelaus added a commit that referenced this issue Mar 25, 2024
@panDanieleN
Copy link
Collaborator

Merged into master.

Updated doc as described.
No need to update tests.

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
Projects
None yet
Development

No branches or pull requests

2 participants