dohertj2/mxaccessgw
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(audit): apply global term/path substitutions across living docs

Browse Source
This commit is contained in:
Joseph Doherty
2026-06-03 15:50:13 -04:00
parent a60c1e3f66
commit f84e0c3474
16 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/style-guides/JavaStyleGuide.md
+1 -1
View File
@@ -22,7 +22,7 @@ library, CLI, and tests.
## Packages
- Use lowercase package names under `com.dohertylan.mxgateway`.
- Use lowercase package names under `com.zb.mom.ww.mxgateway`.
- Keep client library code separate from CLI code.
- Keep generated protobuf classes in a generated package.
- Do not expose implementation-only transport helpers as public API.
docs/style-guides/PythonStyleGuide.md
+2 -2
View File
@@ -24,8 +24,8 @@ CLI, and tests.
## Package Structure
- Put library code under `src/mxgateway/`.
- Put CLI entry points under `src/mxgateway_cli/`.
- Put library code under `src/zb_mom_ww_mxgateway/`.
- Put CLI entry points under `src/zb_mom_ww_mxgateway_cli/`.
- Keep generated protobuf modules under a clearly named `generated` package.
- Avoid import side effects that open channels, read environment variables, or
start background tasks.