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

Export ∆ (\increment) and ∑ (\sum) as aliases of Laplacian() and sum() #761

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

wsshin
Copy link
Contributor

@wsshin wsshin commented Jan 20, 2022

This PR exports and as aliases of Laplacian() and sum().

Note that these symbols are entered by \increment and \sum, and different from Δ (\Delta) and Σ (\Sigma) that are more commonly used as variable names. Therefore, exporting these symbols do not clutter the namespace.

This PR fixes #760. Once this PR is merged, the documentation mentioning Δ (\Delta) as an alias for Laplacian() should be updated with (\increment).

@wsshin wsshin changed the title Export ∆ (\increment) and ∑ (\sum) for Laplacian() and sum() Export ∆ (\increment) and ∑ (\sum) as aliases of Laplacian() and sum() Jan 20, 2022
@codecov
Copy link

codecov bot commented Jan 20, 2022

Codecov Report

Merging #761 (2561b30) into master (fef0c7f) will increase coverage by 0.12%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #761      +/-   ##
==========================================
+ Coverage   30.28%   30.40%   +0.12%     
==========================================
  Files          15       15              
  Lines         809      809              
==========================================
+ Hits          245      246       +1     
+ Misses        564      563       -1     
Impacted Files Coverage Δ
src/Extras/poetry.jl 6.25% <ø> (+6.25%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fef0c7f...2561b30. Read the comment docs.

@dlfivefifty
Copy link
Member

Note this is a breaking change so you should bump the minor version

@jishnub
Copy link
Member

jishnub commented Jul 21, 2022

The visual similarity between \sum and \Sigma would make code using both hard to read. Maybe this shouldn't be exported? Users may import this if their projects aren't likely to use both.

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.

Laplacian symbol Δ is not exported
3 participants