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

Remove duplicated comment about testbed template content in Python bindings #9303

Open
touilleMan opened this issue Jan 8, 2025 · 0 comments
Labels
A-Docs Area: Documentation good first issue Good for newcomers I-Python Impact: Python-related stuff refactor Improve code, don't change behavior

Comments

@touilleMan
Copy link
Member

See for instance:

"""
Coolorg contains:
- 3 users: `alice` (admin), `bob` (regular) and `mallory` (outsider)
- devices `alice@dev1`, `bob@dev1` and `mallory@dev1` whose storages are up to date
- devices `alice@dev2` and `bob@dev2` whose storages are empty
- 1 workspace `wksp1` shared between alice (owner) and bob (reader)
- `wksp1` is bootstrapped (i.e. has it initial key rotation and name certificates).
- Alice & Bob have their user realm created and user manifest v1 synced with `wksp1` in it
- Mallory has no user realm created
- 1 pending invitation from Alice for a new user with email `[email protected]`
- 1 pending invitation for a new device for Alice
See `libparsec/crates/testbed/src/templates/coolorg.rs` for it actual definition.
"""

The testbed templates supposed to change very few since changing them breaks existing tests.
(the idea is instead to create a new template whenever a new need arrives, hence this new workspace_history btw ^^)

However I agree that duplication of comment is always a risk of providing an outdated comment (which would totally defeat the goal of making documentation more accessible from Python code !)

Original comments:

#9292 (review)
#9292 (comment)

@touilleMan touilleMan added the I-Python Impact: Python-related stuff label Jan 8, 2025
@mmmarcos mmmarcos added the refactor Improve code, don't change behavior label Jan 10, 2025
@FirelightFlagboy FirelightFlagboy added A-Docs Area: Documentation good first issue Good for newcomers labels Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Docs Area: Documentation good first issue Good for newcomers I-Python Impact: Python-related stuff refactor Improve code, don't change behavior
Projects
None yet
Development

No branches or pull requests

3 participants