Skip to content

docs: add info subcommands, and miniscule unrelated docs details#192

Merged
consideRatio merged 7 commits intosensmetry:mainfrom
consideRatio:pr/info-docs
Mar 5, 2026
Merged

docs: add info subcommands, and miniscule unrelated docs details#192
consideRatio merged 7 commits intosensmetry:mainfrom
consideRatio:pr/info-docs

Conversation

@consideRatio
Copy link
Copy Markdown
Collaborator

@consideRatio consideRatio commented Mar 3, 2026

image

I bundled a few small details in dedicated commits as well.

  • development docs didn't mention how to work with the docs
  • there was a typo in sysand include's docs about --no-index-symbols flag
  • there was a signature mistake in sysand print-root
  • I used .playwright-cli with claude to help detect a few things here, and update the docs, which made me want to add some stuff into .gitignore as well

@consideRatio consideRatio changed the title docs: add info subcommands docs: add info subcommands, and two unrelated docs details Mar 3, 2026
@consideRatio consideRatio changed the title docs: add info subcommands, and two unrelated docs details docs: add info subcommands, and miniscule unrelated docs details Mar 3, 2026
Copy link
Copy Markdown
Collaborator

@victor-linroth-sensmetry victor-linroth-sensmetry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going through all the help messages I realize that a lot descriptions and value names are lacking or completely missing. It would be good to update those as well to (mostly) match the docs.

Comment thread DEVELOPMENT.md Outdated
Comment thread docs/src/metadata.md Outdated
Comment thread docs/src/commands/info/version.md Outdated
@victor-linroth-sensmetry
Copy link
Copy Markdown
Collaborator

Also remove global = true from all the ResolutionOptions in cli.rs since they don't have any effect when used together with the subcommands anyway.

@consideRatio consideRatio force-pushed the pr/info-docs branch 2 times, most recently from 0aa92a0 to 2120b20 Compare March 4, 2026 09:44
@consideRatio
Copy link
Copy Markdown
Collaborator Author

Also remove global = true from all the ResolutionOptions in cli.rs since they don't have any effect when used together with the subcommands anyway.

I verified that this removal influenced info sub-commands.

The info --help still shows resolution options, and I didn't manage to remove it. I was thinking it should be removable though!

@victor-linroth-sensmetry
Copy link
Copy Markdown
Collaborator

The info --help still shows resolution options, and I didn't manage to remove it. I was thinking it should be removable though!

That's good though since sysand info can be used on on general IRIs you need to be able to configure resolution. The subcommands are only relevant to the current project so they don't need them.

@consideRatio
Copy link
Copy Markdown
Collaborator Author

consideRatio commented Mar 4, 2026

Okay I think this may be ready to go! The build failure is unrelated, and handled via #196. @victor-linroth-sensmetry ready for review again!

Copy link
Copy Markdown
Collaborator

@victor-linroth-sensmetry victor-linroth-sensmetry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Erik Sundell and others added 7 commits March 4, 2026 15:09
Signed-off-by: Erik Sundell <erik.sundell@sensmetry.com>
Signed-off-by: Erik Sundell <erik.sundell@sensmetry.com>
Signed-off-by: Erik Sundell <erik.sundell@sensmetry.com>
Signed-off-by: Erik Sundell <erik.sundell@sensmetry.com>
Co-authored-by: Victor Linroth <victor.linroth@sensmetry.com>
Signed-off-by: Erik Sundell <erik.i.sundell@gmail.com>
Signed-off-by: Erik Sundell <erik.sundell+2025@sensmetry.com>
…affected

Signed-off-by: Erik Sundell <erik.sundell+2025@sensmetry.com>
@consideRatio
Copy link
Copy Markdown
Collaborator Author

Argh, I can't merge without having things pass? Then I need #196 first.

@consideRatio
Copy link
Copy Markdown
Collaborator Author

Huh now I can merge?

@consideRatio consideRatio merged commit 4d71ba4 into sensmetry:main Mar 5, 2026
44 of 45 checks passed
consideRatio added a commit that referenced this pull request Mar 5, 2026
This would have caught a mistake of mine in #192 where I failed to
re-format.
@andrius-puksta-sensmetry
Copy link
Copy Markdown
Collaborator

Also remove global = true from all the ResolutionOptions in cli.rs since they don't have any effect when used together with the subcommands anyway.

They do have an effect. Try sysand info -i urn:kpar:sysmod version --no-index. I added global = true in #127 for this reason.

@victor-linroth-sensmetry
Copy link
Copy Markdown
Collaborator

victor-linroth-sensmetry commented Mar 9, 2026

They do have an effect. Try sysand info -i urn:kpar:sysmod version --no-index. I added global = true in #127 for this reason.

Okay then that needs to be corrected, and also update the docs to reflect this.

Edit: Ideally some tests as well, though that might be delayed.

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.

3 participants