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

Added feature that generates the elementary weight of a rooted tree as a latexstring #155

Merged
merged 16 commits into from
Jan 26, 2024

Conversation

pw0lf
Copy link
Contributor

@pw0lf pw0lf commented Jan 20, 2024

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

Added the feature as described in #96.
Also added test and they all passed.
Added documentation, but the picture of the output is still missing, since I don't remember how to add pictures there ...
This picture should be displayed:
Bildschirmfoto 2024-01-20 um 23 07 43

@pw0lf
Copy link
Contributor Author

pw0lf commented Jan 20, 2024

Almost forgot:
Because a function called elementary_weight already existed, I called the function elementary_weight_latexstring.
Should I rename elementary_differential to elementary_differential_latexstring out of consistency?

@ranocha
Copy link
Member

ranocha commented Jan 22, 2024

Almost forgot: Because a function called elementary_weight already existed, I called the function elementary_weight_latexstring. Should I rename elementary_differential to elementary_differential_latexstring out of consistency?

Good point 👍 Could you please rename the function as suggested - and deprecate the old one?

help?> @deprecate
  @deprecate old new [export_old=true]

  Deprecate method old and specify the replacement call new, defining a new method old with the
  specified signature in the process.

  To prevent old from being exported, set export_old to false.

  │ Julia 1.5
  │
  │  As of Julia 1.5, functions defined by @deprecate do not print warning when julia is
  │  run without the --depwarn=yes flag set, as the default value of --depwarn option is
  │  no. The warnings are printed from tests run by Pkg.test().

  Examples
  ≡≡≡≡≡≡≡≡

  julia> @deprecate old(x) new(x)
  old (generic function with 1 method)

@pw0lf
Copy link
Contributor Author

pw0lf commented Jan 24, 2024

I changed the name and deprecated the old function. Also changed the version number to 3.0.0 since it is a breaking change, right?

Also the picture should be added to the documentation and I don't know how...
Could you help me with that, @ranocha?

@ranocha
Copy link
Member

ranocha commented Jan 25, 2024

The code is something like

![latex elemenary weights](https://private-user-images.githubusercontent.com/125130707/298310491-8a035faf-fd1a-4fc0-92be-c3387eb53177.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MDYxNjY1ODAsIm5iZiI6MTcwNjE2NjI4MCwicGF0aCI6Ii8xMjUxMzA3MDcvMjk4MzEwNDkxLThhMDM1ZmFmLWZkMWEtNGZjMC05MmJlLWMzMzg3ZWI1MzE3Ny5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwMTI1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDEyNVQwNzA0NDBaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1kYzQyYjM0MWY0MDU5YWZlYzBmODA4MjFiZGIxN2E3YjhkYTdmZDNkYTU5NmI5OTEwNWFiZjg0OGZjNDg1MzZhJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.GB-PigOlQqenzgruzWg19qslzM6RXeX4xWwCNreOvNY)

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! It's weird that docs CI fails. I will check it in another clean PR (#157)

@ranocha ranocha merged commit 08275a9 into SciML:main Jan 26, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants