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

Updated setup function to reset parameters and updated the FAQs. #161

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

rai-pranav
Copy link

Summary

  • Added a big red note to clarify that alyx.example.com is not a real database but an example URL.
  • Explained how to reset parameters with defaults for Open Alyx.
  • Added make_default=True to the example and documented this argument.

Fixes #159

@k1o0
Copy link
Collaborator

k1o0 commented Nov 11, 2024

Thanks a lot for contributing! I need to think about whether we want to always use the OpenAlyx defaults in silent mode. Currently silent=True combined with make_default=True allows us to change which database to use by default. With your change this would break all non-public database configurations. For this reason I was leaning towards a reset/clear params method (#155) instead. I'll take a closer look at this PR tomorrow.

@k1o0 k1o0 changed the base branch from main to v3.0.0 November 12, 2024 17:21
@k1o0 k1o0 changed the base branch from v3.0.0 to improveSetup November 12, 2024 17:23
@k1o0
Copy link
Collaborator

k1o0 commented Nov 12, 2024

I think I'll change it slightly to use defaults in silent mode only when it's OpenAlyx. Thanks again for these changes!

@k1o0 k1o0 merged commit f791d8e into int-brain-lab:improveSetup Nov 12, 2024
1 of 5 checks passed
@rai-pranav
Copy link
Author

I was just trying to explore this repo, and found this one issue, as good first issue, so decided to delve into. If there are some other issues that can help in understanding the codebase better etc., and can be handled without knowing too much about the codebase, then I am happy to contribute. Let me know.

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.

Improve FAQ documentation
2 participants