Skip to content

Improve FileStation and update docs parser and docstrings#318

Merged
N4S4 merged 6 commits intomasterfrom
fix/improve-fs-api-and-docs
Jan 5, 2026
Merged

Improve FileStation and update docs parser and docstrings#318
N4S4 merged 6 commits intomasterfrom
fix/improve-fs-api-and-docs

Conversation

@joeperpetua
Copy link
Collaborator

Changes

  • FileStation.get_mount_point_list:
    • mount_type is now required
    • additional has default in def signature
    • additional is now being applied to call
    • offset, limit, sort_by, sort_direction are now being applied to the call
    • update docstring to reflect changes
  • Docs parser:
    • Now supports generating class docstrings with parameters section
    • No longer throws warning when api_name is not defined within a method. It will now simply print an information message. This is to be expected for methods that do not call the API directly.
  • Docs:
    • Fix many instances of broken format in class description
    • Update status file

- mount_type is now required
- `additional` has default in def signature
- `additional` is now being applied to call
- `offset`, `limit`, `sort_by`, `sort_direction` are now being applied to the call
- update docstring to reflect changes
@N4S4 N4S4 merged commit 7a0666a into master Jan 5, 2026
2 checks passed
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.

2 participants