Skip to content

Commit d927deb

Browse files
authored
Merge pull request #3 from gilteunchoi/add-readme
Add README
2 parents 49c74bc + 4083cad commit d927deb

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ or using docker
2727
__doc__ RustPython
2828
$ docker run -v $(pwd):/RustPython -w /RustPython/__doc__ python:slim python generate_docs.py ../RustPython docs.inc.rs
2929

30+
31+
and do not forget to update cargo before the test
32+
```
33+
$ cargo update
34+
```
35+
## Why the `__doc__` is not changed?
36+
37+
### Check the old documentation implemented with remarks are still exist
38+
RustPython prioritizes the user define documentation. Check if the old remarks are remaining in the source code. If it is, simply removing them could solve the issue.
39+
3040
## Contributing
3141

3242
Contributions are more than welcome, and in many cases we are happy to guide
@@ -40,4 +50,4 @@ This project is licensed under the MIT license. Please see the
4050

4151
The [project logo](https://github.com/RustPython/RustPython/logo.png) is licensed under the CC-BY-4.0
4252
license. Please see the [LICENSE-logo](https://github.com/RustPython/RustPython/LICENSE-logo) file
43-
for more details.
53+
for more details.

logo.png

18.3 KB
Loading

0 commit comments

Comments
 (0)