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

constants not doucmented #118

Closed
ManuelSchneid3r opened this issue Jan 10, 2023 · 6 comments
Closed

constants not doucmented #118

ManuelSchneid3r opened this issue Jan 10, 2023 · 6 comments

Comments

@ManuelSchneid3r
Copy link

Hi,
I use your lib (thank you by the way) in albertlauncher/albert. I link your documentation from the app for users. I noticed that the constants are not documented. It would be nice if you could document the constants _e ,_pi, etc (maybe some i dont know) in the online docs.

By the way is there a reason why they are prefixed with an underscore?

@beltoforion
Copy link
Owner

Sure I can add the constants. The reason for using the underscore in constant names is lost to history.

@ManuelSchneid3r
Copy link
Author

lost to history.

i dont get that. not a native speaker, sorry. can you please rephrase?

@beltoforion
Copy link
Owner

No problem. It means that I have no recollection or documentation that explains why i choose to use the underscore in the variable name. Probably to mark it as a constant that is built in.

@ManuelSchneid3r
Copy link
Author

Can we remap the names? E.g. from _pi to pi. Or do you mind to change these generally?

@beltoforion
Copy link
Owner

beltoforion commented Jan 18, 2023

Probably not because that is how they are named for a long time and a lot of people will start complaining if i change them. You can however define your own constants.

Or let me put it this way: If i come to the conclusion that a majority of active users is in favor of changing the name and if the renaming does not collide with existing functionality (such as "e" conflicting with exponential format) I will probably change it.

@beltoforion
Copy link
Owner

Documentation updated

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

No branches or pull requests

2 participants