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 docs chapter on default units and physical constants #729

Merged
merged 3 commits into from
Oct 4, 2024

Conversation

Eben60
Copy link
Contributor

@Eben60 Eben60 commented Jun 1, 2024

Adding (only) documentation page on default units and physical constants, as requested in #623 - a temporary alternative to generation of this documentation as suggested in #704.

The PR #704 is somewhat stalled: Having the script to do exactly what we want might take time.

I have now manually edited the (initially generated) doc page according to @sostock remarks (#704 (comment), #704 (comment), #704 (comment)).

Could we probably merge this docs page as a provisional solution?

@Eben60
Copy link
Contributor Author

Eben60 commented Oct 4, 2024

Any chance?

I created this because of the frustration due to lack of units documentation: the only way to find out being studying the source code. As Unitful belongs to the most used packages in the Julia ecosystem, one can safely assume I was not alone with my frustration.

I understand automatic generation of the docs as in my PR #704 could in theory have some unexpected implications, must be thoroughly checked etc. But what could speak against merging just the docs page according to the current PR?

☹️

@giordano giordano merged commit e68fc69 into PainterQubits:master Oct 4, 2024
13 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