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

port SimJulia.jl 'school' example and add description of that to the docs #106

Closed
asmirnov69 opened this issue Feb 2, 2024 · 3 comments · Fixed by #107
Closed

port SimJulia.jl 'school' example and add description of that to the docs #106

asmirnov69 opened this issue Feb 2, 2024 · 3 comments · Fixed by #107

Comments

@asmirnov69
Copy link
Contributor

asmirnov69 commented Feb 2, 2024

This example would be particular useful to have in ConcurrentSim.jl documentation: school


I start using ConcurrentSim.jl as part of my implementation of Julia-based discrete simulation project. Since it is first time I am doing such kind of code I am frequently using more friendly docs from SimJulia.jl project: https://simjuliajl.readthedocs.io/en/stable/welcome.html

I'd like to suggest to add more documentation into ConcurrentSim.jl to 'Topical Guides/Events' section of documentation. At glance it looks like the task of taking old SimJulia.jl docstring and put it into ConcurrentSim.jl, making sure that example code is actually works.

@Krastanov
Copy link
Member

Hi, asmirnov69! You are right, but there are a few issues: The old docs you are looking at are for a very old version of SimJulia, long before SimJulia was renamed to ConcurrentSim. These docs were discarded due to changes that were made to SimJulia before any name changes. They were discarded because internal changes in SimJulia made them incorrect. ConcurrentSim did not delete any docs that were available at the time of transition.

Thus, some of the examples you are relying on might be randomly incorrect (some of them will still be fine). The original developer did not have the bandwidth to translate all examples.

Most importantly though, I completely agree with you that we need more docs. We are a bit short staffed though, so it would not happen in the next few months. If you would like to help this open source project, I would be eager to help you contribute documentation and examples.

@asmirnov69 asmirnov69 changed the title more docs for beginners port SimJulia.jl 'school' example and add description of that to the docs Feb 2, 2024
@asmirnov69
Copy link
Contributor Author

yes, i will try to contribute docs and examples. to move ahead with this particular issue and possibly more. I want concentrate on school example since that is very close to what I am doing right now.

@Krastanov
Copy link
Member

wonderful! That would be greatly appreciated

asmirnov69 added a commit to asmirnov69/ConcurrentSim.jl that referenced this issue Feb 3, 2024
…d SimJulia doc, tested, seems to be working as expected
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 a pull request may close this issue.

2 participants