PYD-1399: Add environments documentation #591
Merged
Hyperlint AI / Hyperlint Style Guide
succeeded
Nov 14, 2024 in 5s
👏 No style guide issues found.
2 files reviewed, no outstanding issues found.
Details
📄 docs/guides/advanced/index.md
| Line | Issues | Text | Comment |
|---|---|---|---|
| 7 | (Spelling-error) Did you really mean 'dev'? | Existing:* **[Using Environments](using-environments.md):** Group data between environments (e.g. dev, staging, prod) within a project. | The term 'dev' is a widely accepted shorthand for 'development' in technical contexts, particularly when referring to different environments. It is not a spelling error but a common industry term. Therefore, no change is necessary. |
📄 docs/guides/advanced/using-environments.md
| Line | Issues | Text | Comment |
|---|---|---|---|
| 54 | (Spelling-error) Did you really mean 'dev'? | Existing:for details). So if you need to allow different team members to view dev vs. prod traces, then projects would be a better fit. | The term 'dev' is a widely accepted shorthand for 'development' in technical contexts. Unless the style guide specifically prohibits such shorthand, it is generally acceptable to use 'dev' in this context. No change is necessary. |
🪄 About Hyperlint
Hyperlint is your AI-powered copilot for creating high-quality documentation with minimal effort.
Sign up for a free plan at hyperlint.com.
Loading