https://github.com/atelierarith/docstringtranslation.jl
Translate docstrings in Julia into your preferred language.
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.7%) to scientific vocabulary
Keywords
Repository
Translate docstrings in Julia into your preferred language.
Basic Info
- Host: GitHub
- Owner: AtelierArith
- License: mit
- Language: Julia
- Default Branch: main
- Homepage: https://atelierarith.github.io/DocstringTranslation.jl/
- Size: 344 KB
Statistics
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 2
Topics
Metadata Files
README.md
DocstringTranslation.jl
<!-- DeepWiki badge generated by https://deepwiki.ryoppippi.com/ -->
Description
This Julia package inserts Large Language Model (LLM) hooks into the API in the Base.Docs module, giving non-English speaking users the opportunity to help smooth API comprehension.
Prerequisite
Install Julia
Install Julia using juliaup.
sh
$ curl -fsSL https://install.julialang.org | sh -s -- --yes
Get OpenAI API Key
Currently, this package utilizes OpenAI.jl, a OpenAPI wrapper for Julia. Please prepare API key. See the following resources to learn more
Set OPENAI_API_KEY environment variable
To use the OpenAI API, you'll need to set your API key as an environment variable named OPENAI_API_KEY.
Create a file named .env the current working directory. Add the following line to the .env file, replacing
OPENAI_API_KEY=sk-<your_api_key>
Use the DotEnv.jl package to load the environment variables from the .env file:
```julia using Pkg; Pkg.add("DotEnv") using DotEnv
DotEnv.load!() ```
To ensure the API key is set correctly, use the following Julia code:
julia
@assert haskey(ENV, "OPENAI_API_KEY")
This assertion will throw an error if the OPENAI_API_KEY environment variable is not defined.
Usage
``sh
$ cd path/to/directory
$ julia
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _ | |
| | || | | | (| | | Version 1.11.1 (2024-10-16)
/ |_'|||_'| | Official https://julialang.org/ release
|_/ |
julia> using Pkg; Pkg.activate("."); Pkg.instantiate()
julia> using DocstringTranslation
julia> using DotEnv
julia> DotEnv.load!()
julia> @switchlang! :Japanese
julia> @doc pi π pi
定数pi。
Unicode πはJulia REPLで\piと入力してからタブキーを押すことで入力できます。また、多くのエディタでも同様です。
参照: sinpi、sincospi、deg2rad。
例 ≡≡
julia> pi π = 3.1415926535897...
julia> 1/2pi 0.15915494309189535
julia> @switchlang! :German
julia> # You can also ask from help mode
help?> ℯ julia> @doc ℯ ℯ e
Die Konstante ℯ.
Unicode ℯ kann eingegeben werden, indem man \euler schreibt und die Tabulatortaste im Julia REPL und in vielen Editoren drückt.
Siehe auch: exp, cis, cispi.
Beispiele ≡≡≡≡≡≡≡≡≡
julia> ℯ ℯ = 2.7182818284590...
julia> log(ℯ) 1
julia> ℯ^(im)π ≈ -1 true
julia> ```
Appendix
If you are using 1PassWord, op command is good for you. Store the following content instead of writing API key directly:
```
.env
OPENAIAPIKEY=op://Personal/OpenAI API Key/api key ```
To launch julia run the following command:
sh
$ op run --env-file=./.env -- julia
In this case, you don't have to load DotEnv package:
``julia
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _ | |
| | || | | | (| | | Version 1.11.5 (2025-04-14)
/ |_'|||_'| | Official https://julialang.org/ release
|_/ |
julia> using DocstringTranslation; @switchlang! :Japanese; @doc exp
```
Owner
- Name: AtelierArith
- Login: AtelierArith
- Kind: organization
- Email: contact@atelier-arith.jp
- Location: Japan
- Twitter: AtelierArith
- Repositories: 8
- Profile: https://github.com/AtelierArith
Enhance "Math meets Art"
GitHub Events
Total
- Create event: 7
- Release event: 1
- Issues event: 4
- Watch event: 4
- Delete event: 7
- Issue comment event: 12
- Public event: 1
- Push event: 58
- Pull request event: 9
Last Year
- Create event: 7
- Release event: 1
- Issues event: 4
- Watch event: 4
- Delete event: 7
- Issue comment event: 12
- Public event: 1
- Push event: 58
- Pull request event: 9
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| SatoshiTerasaki | t****h@g****m | 56 |
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 2
- Total pull requests: 7
- Average time to close issues: 3 days
- Average time to close pull requests: less than a minute
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 7.0
- Average comments per pull request: 0.0
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 7
- Average time to close issues: 3 days
- Average time to close pull requests: less than a minute
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 7.0
- Average comments per pull request: 0.0
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- terasakisatoshi (1)
- JuliaTagBot (1)
Pull Request Authors
- terasakisatoshi (13)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 16 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
juliahub.com: DocstringTranslation
Translate docstrings in Julia into your preferred language.
- Homepage: https://atelierarith.github.io/DocstringTranslation.jl/
- Documentation: https://docs.juliahub.com/General/DocstringTranslation/stable/
- License: MIT
-
Latest release: 0.1.1
published about 1 year ago