Skip to content

Commit

Permalink
fix: modify comment
Browse files Browse the repository at this point in the history
  • Loading branch information
nakul1010 committed Nov 25, 2023
1 parent 8bd56c9 commit 27d6d5c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs_reformat_scripts/forge_doc_reformat.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
This Python script is designed to modify the Markdown files generated by the 'forge doc' command.
The 'forge doc --out docs/docs/contracts' command doesn't return the docs in the right format for Docusaurus.
Therefore, run this script before publishing the doc to make it compatible with Docusaurus.
Therefore, run this script after running the `forge doc --out docs/docs/contracts` & before publishing the doc to make it compatible with Docusaurus.
"""

import os
Expand Down

0 comments on commit 27d6d5c

Please sign in to comment.