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

docs: add signature_name to docstring and all content options section #290

Merged
merged 2 commits into from
Oct 6, 2023
Merged

docs: add signature_name to docstring and all content options section #290

merged 2 commits into from
Oct 6, 2023

Conversation

machow
Copy link
Owner

@machow machow commented Oct 5, 2023

This PR documents the signature_name argument, which controls how much of an objects name to show in its signature. E.g.

  • relative (default): whatever the user specified as the name: argument
  • full: the full path to the object
  • short: just the object name (i.e. no periods)

@machow machow marked this pull request as ready for review October 6, 2023 15:08
@machow machow merged commit 106fb1a into main Oct 6, 2023
5 checks passed
@machow machow deleted the doc-quartodoc-signature-name branch October 12, 2023 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@machow