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.

Sign up for GitHub

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

Jump to bottom

Add docstring to Domain.join() #140

Open
yguclu opened this issue Sep 20, 2023 · 0 comments
Open

Add docstring to Domain.join() #140

yguclu opened this issue Sep 20, 2023 · 0 comments
Assignees
@yguclu
Labels
documentation

Comments

@yguclu
Copy link
Member

yguclu commented Sep 20, 2023 •
edited
Loading

The method join of class Domain, albeit very powerful, is not documented. At the very least an extended docstring should be provided. The necessary information can be found in PR #130.
@yguclu yguclu mentioned this issue Mar 19, 2024
Merged
@yguclu yguclu self-assigned this May 29, 2024
@campospinto campospinto mentioned this issue Jun 3, 2024
Merged
1 task
campospinto added a commit that referenced this issue Jul 19, 2024
@campospinto
improving Domain.join (#155)
b116110 
A docstring is added for Domain.join(), and also the possibility of passing directly the patch objects in the connectivity list, instead of their indices in the patch list -- this makes the function calls more robust as the result does not depend on the order of the patch list.

This PR also fixes issue [#140](#140)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yguclu yguclu

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@yguclu