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

Suggestion to clean up redundant module names in Brainpy #463

Closed
CloudyDory opened this issue Aug 28, 2023 · 2 comments
Closed

Suggestion to clean up redundant module names in Brainpy #463

CloudyDory opened this issue Aug 28, 2023 · 2 comments
Assignees

Comments

@CloudyDory
Copy link
Contributor

Hi, thanks for your time and effort in developing Brainpy. It's a great tool to use.

However, when reading the brainpy examples, I found different tutorial files use different module names, which actually refer to the same underlying module, and this can easily confuse newcomers when learning Brainpy.

For example:

And actually, bp.NeuGroup, bp.dyn.NeuDyn, and bp.dyn.NeuGroup all refer to brainpy._src.dyn.base.NeuDyn, so if I understand correctly, the three are completely the same. If this is true, I suggest keeping only one and using it consistently throughout the tutorials.

Another example is bp.Network and bp.DynSysGroup, which both refer to brainpy._src.dynsys.DynSysGroup. The two names look very different, so I also suggest to keep only one.

@chaoming0625
Copy link
Collaborator

Thanks for raising this question. This is indeed a problem. However, we have always been busy. I hope there are contributors who can help us fix and improve these issues.

@ztqakita
Copy link
Collaborator

Great suggestion! I will clean up the example docs to the latest version as soon as possible.

chaoming0625 added a commit that referenced this issue Sep 16, 2023
[doc] upgrade docs with the latest APIs, fix #463
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

4 participants