docs: use parentheses for callable names in prose (DOCS-1362)#2327
Open
johndmulhausen wants to merge 21 commits intomainfrom
Open
docs: use parentheses for callable names in prose (DOCS-1362)#2327johndmulhausen wants to merge 21 commits intomainfrom
johndmulhausen wants to merge 21 commits intomainfrom
Conversation
- Update English docs and release notes so functions and methods are written as `wandb.init()`, `run.log()`, and similar in running text (outside code fences). - Document the convention and link to Global Functions overview in AGENTS.md. - Normalize `wandb.controller()` link text and a few `wandb.restore()` release note lines. Resolves DOCS-1362 Made-with: Cursor
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (48 total)📄 Pages (48)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-functions-should-have-parentheses.mintlify.app |
- Added .env to .gitignore to prevent environment variable files from being tracked. - Corrected function name references in documentation from `wandb.log_artifacts` to `wandb.log_artifact()` for consistency and clarity.
- Updated documentation to ensure consistency by adding parentheses to function calls, such as `run.finish_artifact()`, `wandb.tensorboard.patch()`, and `weave.init()`. - Improved clarity in various sections by correcting function references to match the standard format.
- Updated documentation to ensure consistency by adding parentheses to function calls, such as `wandb.log()`, `weave.init()`, and various other method references across different integration guides. - Improved clarity and uniformity in the documentation for better readability and understanding.
johndmulhausen
commented
Mar 20, 2026
ngrayluna
requested changes
Mar 23, 2026
Contributor
|
Summoning @dbrian57 to verify Weave-related methods, etc. |
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Contributor
Author
|
@ngrayluna Would appreciate if you can make the SDK edits. Also, is it |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns English documentation with the convention that functions and methods are written with trailing
()when mentioned in prose (not inside code samples), for examplewandb.init()andrun.log().Changes
ja/,ko/, andsupport/were not included).wandb.controller()link text,wandb.restore()in a few historical release-note bullets, and backtick cleanup in ref prose wherewandb.init()appeared without code formatting.Issue
Resolves DOCS-1362
Made with Cursor