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 tweaks #4768

Merged
merged 6 commits into from
Jul 18, 2024
Merged

docs tweaks #4768

merged 6 commits into from
Jul 18, 2024

Conversation

willmcgugan
Copy link
Collaborator

@willmcgugan willmcgugan commented Jul 17, 2024 •
edited
Loading

  • Replace titles in API reference with their imports.
  • Enables labels from mkdocstrings which mark attributes, methods etc.
  • A few fixed linked, updates to doc wording.

Fixes #4743

@willmcgugan willmcgugan requested a review from darrenburns July 17, 2024 20:29
@merriam
Copy link
Contributor

merriam commented Jul 18, 2024

Could you explain why you did these changes?

@darrenburns
Copy link
Member

@merriam In order:

  • As per documentation issues #4743 people weren't clear on where to import modules from when reading the API reference.
  • When reading the API reference, this adds labels indicating whether an entry is a function/method/class/module, etc.
image
  • Self-explanatory

@willmcgugan willmcgugan merged commit 158e0b3 into main Jul 18, 2024
16 of 17 checks passed
@willmcgugan willmcgugan deleted the docs-mods branch July 18, 2024 08:50
@merriam
Copy link
Contributor

merriam commented Jul 21, 2024

great! Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@darrenburns darrenburns darrenburns approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

documentation issues
3 participants
@willmcgugan @merriam @darrenburns