Skip to content

Commit 3772a3c

Browse files
committed
Link titles improvements to render properly at graalvm.org
1 parent 5fdef44 commit 3772a3c

File tree

4 files changed

+19
-21
lines changed

4 files changed

+19
-21
lines changed

doc/CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
### Contributing to the GraalVM Implementation of Python
1+
# Contributing GraalPython
22

33
Thanks for considering to contribute! To get you started, here is a bit of
44
information about the structure of this implementation.
55

6-
##### But first...
7-
8-
You will need to sign the [Oracle Contributor
9-
Agreement](http://www.graalvm.org/community/contributors/) for us to be able to
6+
You will need to sign the [Oracle Contributor Agreement](http://www.graalvm.org/community/contributors/) for us to be able to
107
merge your work.
118

12-
Please also take some time to review our [code of
13-
conduct](http://www.graalvm.org/community/conduct/) for contributors.
9+
Please also take some time to review our [code of conduct](http://www.graalvm.org/community/conduct/) for contributors.
1410

1511
##### Getting started
1612

@@ -83,20 +79,24 @@ modules that we have adapted from C Python.
8379
##### Debug options
8480

8581
The GraalVM implementation of Python provides proper debug options. It is possible to either debug the Python code, using Chrome debugger,
86-
or the java code, using your preferred IDE.
82+
or the java code, using your preferred IDE.
8783
The following commands should be executed in a virtualenv environment, which provides a graalpython executable.
8884

8985
For debug Python side code call this:
9086

91-
```graalpython --inspect your_script.py ```
87+
```
88+
graalpython --inspect your_script.py
89+
```
9290

9391
This will open a debug server, which can be accessed in Chrome Browser under URL `chrome://inspect`.
9492

9593
For debugging java implemented code execute:
9694

97-
```graalpython --experimental-options -debug-java your_script.py```
95+
```
96+
graalpython --experimental-options -debug-java your_script.py
97+
```
9898

99-
The command will also start a debug server, which can be used in an IDE. If the IDE was initialized properly
99+
The command will also start a debug server, which can be used in an IDE. If the IDE was initialized properly
100100
by using the command mentioned above, the existing `GraalDebug` run configuration can be used to debug.
101101

102102
### Advanced commands to develop and debug

doc/IMPLEMENTATION_DETAILS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Python's global thread state
1+
# Python Global Thread State
22

33
In CPython, each stack frame is allocated on the heap, and there's a global
44
thread state holding on to the chain of currently handled exceptions (e.g. if
@@ -78,7 +78,7 @@ exception. Unlike CPython we do not use a stack of currently handled exceptions,
7878
instead we utilize the call stack of Java by always passing the current exception
7979
and holding on to the last (if any) in a local variable.
8080

81-
## Abstract operations on Python objects
81+
## Abstract Operations on Python Objects
8282

8383
Many generic operations on Python objects in CPython are defined in the header
8484
files `abstract.c` and `abstract.h`. These operations are widely used and their

doc/JYTHON.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ implementation of Python, in contrast, is only targeting Python 3.x.
77

88
Nonetheless, there are certain features of Jython's Java integration that we can
99
offer similarly. Some features are more expensive to offer, and thus are hidden
10-
behind a commandline flag, `--python.EmulateJython`.
10+
behind a command line flag, `--python.EmulateJython`.
1111

12-
## Importing Java classes and packages
12+
## Importing Java Classes and Packages
1313

1414
In the default mode, Java classes can only be imported through the `java`
1515
package. Additionally, only Java classes can be imported, not packages. In
@@ -44,18 +44,18 @@ speculative imports in the standard library), we ask the Java classloader to
4444
list currently available packages and traverse them to check if we should create
4545
a Java package. This slows down startup significantly.
4646

47-
## Interacting with Java objects
47+
### Interacting with Java Objects
4848

4949
Once you get hold of a Java object or class, interaction in both modes works
5050
naturally. Public fields and methods can be read and invoked as expected.
5151

52-
## Subclassing Java classes and implementing interfaces with Python classes
52+
### Subclassing Java classes and Implementing Interfaces with Python Classes
5353

5454
This is not supported at all right now, there's no emulation available even in
5555
Jython compatibility mode. We have not seen many uses of this in the wild. Let
5656
us know if this is of interest to you!
5757

58-
## Catching Java exceptions
58+
### Catching Java exceptions
5959

6060
By default this is not allowed, because of the additional cost of checking for
6161
Java exceptions in the except statement execution. However, in Jython

doc/POLYGLOT.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
## Interop
2-
3-
#### Interop from Python
1+
# Interoperability
42

53
You can import the `polyglot` module to interact with other languages.
64

0 commit comments

Comments
 (0)