Skip to content

Commit 7818259

Browse files
author
rocky
committed
Correct spelling typos
1 parent 479444b commit 7818259

File tree

5 files changed

+150
-5
lines changed

5 files changed

+150
-5
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
name: Bug report
3+
about: Tell us about pyc-xasm bugs
4+
5+
---
6+
7+
<!-- __Note:__ If you are using this program to do something illegal - don't.
8+
The issue may be flagged to make it easier for those looking for illegal activity.
9+
10+
Bugs are not for asking questions about a problem you
11+
are trying to solve that involve the use of xasm along the way,
12+
although I may be more tolerant of this if you sponsor the project.
13+
14+
Bugs are also not for general or novice kind help on how to install
15+
this Python program in your environment in the way you would like to
16+
have it set up, or how to interpret a Python traceback e.g. that winds
17+
up saying Python X.Y.Z is not supported.
18+
19+
For these kinds of things, you will save yourself time by asking
20+
instead on forums like StackOverflow that are geared to helping people
21+
for such general or novice kinds questions and tasks. And unless you
22+
are a sponsor of the project, if your question seems to be of this
23+
category, the issue may just be closed.
24+
25+
Also, the unless you are a sponsor of the project, it may take a
26+
while, maybe a week or so, before the bug report is noticed, let alone
27+
acted upon.
28+
29+
To set expectations, some legitimate bugs can take years to fix, but
30+
they eventually do get fixed.
31+
32+
Funding the project was added to partially address the problem that there are
33+
lots of people seeking help and reporting bugs, but few people who are
34+
willing or capable of providing help or fixing bugs.
35+
36+
Tasks or the kinds of things others can do, but you can't do or don't
37+
want to do yourself are typically the kind of thing that you pay
38+
someone to do, especially when you are the primary beneficiary of the
39+
work, or the task is complex, long, or tedious. If your code is over
40+
30 lines long, it fits into this category.
41+
42+
43+
-->
44+
45+
## Description
46+
47+
<!-- Please add a clear and concise description of the bug. Try to narrow the problem down to the smallest that exhibits the bug.-->
48+
49+
## How to Reproduce
50+
51+
<!-- Please show both the *input* you gave and the
52+
output you got in describing how to reproduce the bug:
53+
54+
or give a complete console log with input and output
55+
56+
```console
57+
$ pyc-xasm <command-line-options>
58+
...
59+
$
60+
```
61+
62+
Provide links to the Python bytecode. For example, you can create a
63+
gist with the information. If you have the correct source code, you
64+
can add that too.
65+
66+
-->
67+
68+
## Output Given
69+
70+
<!--
71+
Please include not just the error message but all output leading to the message which includes echoing input and messages up to the error.
72+
For a command-line environment include command invocation and all the output produced.
73+
74+
If this is too long, then try narrowing the problem to something short.
75+
-->
76+
77+
78+
## Expected behavior
79+
80+
<!-- Add a clear and concise description of what you expected to happen. -->
81+
82+
## Environment
83+
84+
<!-- _This section sometimes is optional but helpful to us._
85+
86+
Please modify for your setup
87+
88+
- `pip show pyc-xasm`
89+
- Python version for the version of Python the byte-compiled the file: `python -c "import sys; print(sys.version)"` where `python` is the correct CPython or PyPy binary.
90+
- OS and Version: [e.g. Ubuntu bionic]
91+
92+
-->
93+
94+
## Workarounds
95+
96+
<!-- If there is a workaround for the problem, describe that here. -->
97+
98+
## Priority
99+
100+
<!-- If this is important for a particular public good state that here.
101+
If this is blocking some important activity let us know what activity it blocks.
102+
103+
Otherwise, we'll assume this has the lowest priority in addressing.
104+
-->
105+
106+
## Additional Context
107+
108+
<!-- _This section is optional._
109+
110+
Add any other context about the problem here or special environment setup.
111+
112+
-->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: False

‎.github/ISSUE_TEMPLATE/feature-request.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature Request
3+
about: Tell us about a new feature that you would like to see in pyc-xasm
4+
5+
---
6+
7+
## Description
8+
9+
<!-- Add a short description of the feature. This might
10+
include same input and output. -->
11+
12+
## Background
13+
14+
<!-- Add any additional background for the
15+
feature, for example: user scenarios, or the value of the feature. -->
16+
17+
## Priority
18+
19+
<!-- If this is important for a particular public, state that here.
20+
If this is blocking some important activity let us know what activity it blocks.
21+
If you are asking about a release because you are packing for a distribution like Ubuntu or Fedora, BlackArch, say so. I generally make releases otherwise on whim or when I have a need, such as I am giving a talk. If you sponsor, the project your release request has greater importance.
22+
23+
Otherwise, we'll assume whatever is wrong or needed has the lowest priority in addressing.
24+
25+
-->
26+
27+
## Tests
28+
<!-- _This section is optional._
29+
30+
Add text with suggestions on how to test the feature,
31+
if it is not obvious.
32+
-->

‎HOW-TO-USE.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Module-level info
5454
------------------
5555

5656

57-
The only necessary mdoule-level inforamtion that is needed is the
57+
The only necessary mdoule-level inforamation that is needed is the
5858
Python "magic" number which determines which Python bytecode opcodes
5959
to use and which Python interpreter can be used to run the resulting
6060
program.
@@ -72,7 +72,7 @@ Here is an example of the module-level information:
7272
# Timestamp in code: 1499156389 (2017-07-04 04:19:49)
7373
# Source code size mod 2**32: 577 bytes
7474

75-
Again, the bytecode numberf is necessary. However the timestamp is not. In Python 3
75+
Again, the bytecode number is necessary. However the timestamp is not. In Python 3
7676
there is also a size modulo 2**32 that is recorded, and in later Python this can be a
7777
SIP hash.
7878

@@ -86,7 +86,7 @@ Method-level information starts with ``#`` in column one. Here is some
8686
method-level information:
8787

8888
* The method name of the code object (``Method Name``)
89-
* Number of local variables used in module or fuction (``Number of locals``)
89+
* Number of local variables used in module or function (``Number of locals``)
9090
* A filename where the file (``Filename``)
9191
* Maximum Stack Size needed to run code (``Stack Size``)
9292
* Code flags which indicate properties of the code (``Flags``)

‎README.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The code requires Python 2.7 or later.
3131
Assembly files
3232
--------------
3333

34-
See how-to-use_ for more deatil. Some general some principles:
34+
See how-to-use_ for more detail. Some general some principles:
3535

3636
* Preferred extension for Python assembly is ``.pyasm``
3737
* assembly is designed to work with the output of ``pydisasm -F xasm``
@@ -144,7 +144,7 @@ command from `xdis`:
144144

145145
pydisasm --format xasm /tmp/five.pyc
146146

147-
In the example above though, I have shortend and simplified the result.
147+
In the example above though, I have shortened and simplified the result.
148148

149149

150150
Usage

0 commit comments

Comments
 (0)