Skip to content

Commit f2f124a

Browse files
Dmytro Korenkevychfacebook-github-bot
Dmytro Korenkevych
authored andcommitted
WIP documentation generation via gh actions (facebookresearch#107)
Summary: Pull Request resolved: facebookresearch#107 Differential Revision: D67157339
1 parent c9576ed commit f2f124a

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

.github/workflows/CI.yml

+4
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ jobs:
1717
python-version: 3.9
1818
- name: Install dependencies
1919
run: |
20+
pip install pdoc3
2021
pip install pytest
2122
pip install pytest-cov
2223
pip install -e .
24+
- name: Update documentation
25+
run: |
26+
pdoc -o ./html pearl
2327
- name: Generate coverage report
2428
run: |
2529
pytest --cov=./ --cov-report=xml

pearl/api/action_result.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ class ActionResult:
2323
reward: Reward
2424
terminated: bool
2525
truncated: bool
26-
info: dict[str, Any] | None = None
27-
cost: float | None = None
28-
available_action_space: ActionSpace | None = None
26+
info: Optional[dict[str, Any]] = None
27+
cost: Optional[float] = None
28+
available_action_space: Optional[ActionSpace] = None
2929

3030
@property
3131
def done(self) -> bool:

0 commit comments

Comments
 (0)