Skip to content

fix WebAssembly spelling #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![Docs build](https://readthedocs.org/projects/py-wasm/badge/?version=latest)](http://py-wasm.readthedocs.io/en/latest/?badge=latest)


A python implementation of the web assembly interpreter
A python implementation of the WebAssembly interpreter

Read more in the [documentation on ReadTheDocs](https://py-wasm.readthedocs.io/). [View the change log](https://py-wasm.readthedocs.io/en/latest/releases.html).

Expand Down Expand Up @@ -106,7 +106,7 @@ The test suite in this library is run using `pytest`.
pytest tests/
```

Part of the test suite includes the *spec* tests from the official Web Assembly
Part of the test suite includes the *spec* tests from the official WebAssembly
spec. These are found under `./tests/spec`.

It is often useful to view logging output when running tests. This can be done with:
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@
# dir menu entry, description, category)
texinfo_documents = [
('index', 'py-wasm', 'py-wasm Documentation',
'Jason Carver', 'py-wasm', 'A python implementation of the web assembly interpreter',
'Jason Carver', 'py-wasm', 'A python implementation of the WebAssembly interpreter',
'Miscellaneous'),
]

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
py-wasm
==============================

A python implementation of the web assembly interpreter
A python implementation of the WebAssembly interpreter

Contents
--------
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
name='py-wasm',
# *IMPORTANT*: Don't manually change the version here. Use `make bump`, as described in readme
version='0.1.0-alpha.0',
description="""py-wasm: A python implementation of the web assembly interpreter""",
description="""py-wasm: A python implementation of the WebAssembly interpreter""",
long_description_markdown_filename='README.md',
author='Jason Carver',
author_email='ethcalibur+pip@gmail.com',
Expand Down
2 changes: 1 addition & 1 deletion wasm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

if sys.byteorder != 'little':
raise ImportError(
f"Web assembly operates on little endian encoded values. This library's "
f"WebAssembly operates on little endian encoded values. This library's "
f"use of numpy uses the system's endianness. The current system's "
f"endianness is {sys.byteorder} which isn't compatible."
)
2 changes: 1 addition & 1 deletion wasm/execution/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

class BaseConfiguration(ABC):
"""
Base class for the Configuration object used for execution Web Assembly
Base class for the Configuration object used for execution WebAssembly
"""
store: Store
current_instruction: BaseInstruction
Expand Down
2 changes: 1 addition & 1 deletion wasm/execution/instructions.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

class InstructionSequence(Sequence):
"""
Stateful stream of instructions for web assembly execution.
Stateful stream of instructions for WebAssembly execution.
"""
_instructions: Tuple[BaseInstruction, ...]

Expand Down
8 changes: 4 additions & 4 deletions wasm/execution/runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ def _compute_data_offsets(store: Store,

class Runtime:
"""
Represents the *runtime* for the py-wasm Web Assembly interpreter.
Represents the *runtime* for the py-wasm WebAssembly interpreter.
"""
store: Store
modules: Dict[str, ModuleInstance]
Expand Down Expand Up @@ -217,7 +217,7 @@ def _get_import_addresses(self, imports: Tuple[Import, ...]) -> Tuple[TAddress,

def load_module(self, file_path: Path) -> Module:
"""
Load a Web Assembly module from its binary source file.
Load a WebAssembly module from its binary source file.
"""
if file_path.suffix != ".wasm":
raise Exception("Unsupported file type: {file_path.suffix}")
Expand All @@ -237,7 +237,7 @@ def load_module(self, file_path: Path) -> Module:

def load_buffer(self, buffer: IO) -> Module:
"""
Load a Web Assembly module from its binary source file.
Load a WebAssembly module from its binary source file.
"""
try:
module = parse_module(buffer)
Expand All @@ -255,7 +255,7 @@ def instantiate_module(self,
module: Module,
) -> Tuple[ModuleInstance, Optional[Tuple[TValue, ...]]]:
"""
Instantiate a Web Assembly module into this runtime environment.
Instantiate a WebAssembly module into this runtime environment.
"""
# Ensure the module is valid
try:
Expand Down
6 changes: 3 additions & 3 deletions wasm/execution/stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

class OperandStack(BaseStack[TValue]):
"""
A stack used for operands during Web Assembly execution
A stack used for operands during WebAssembly execution
"""
pass

Expand Down Expand Up @@ -67,7 +67,7 @@ def __init__(self,

class ControlStack(BaseStack[Label]):
"""
A stack used for labels during Web Assembly execution
A stack used for labels during WebAssembly execution
"""
def get_label_by_idx(self, key: LabelIdx) -> Label:
return self._stack[-1 * (key + 1)]
Expand Down Expand Up @@ -138,6 +138,6 @@ def has_active_label(self) -> bool:

class FrameStack(BaseStack[Frame]):
"""
A stack used for frames during Web Assembly execution
A stack used for frames during WebAssembly execution
"""
pass
2 changes: 1 addition & 1 deletion wasm/parsers/magic.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

def parse_magic(stream: IO[bytes]) -> Tuple[numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8]:
"""
Parser for the *magic* 4-byte preamble for a binary encoded Web Assembly module.
Parser for the *magic* 4-byte preamble for a binary encoded WebAssembly module.

https://webassembly.github.io/spec/core/bikeshed/index.html#binary-magic
"""
Expand Down
2 changes: 1 addition & 1 deletion wasm/parsers/sections.py
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ def normalize_sections(sections: Tuple[SECTION_TYPES, ...]) -> T_SECTIONS:

def parse_sections(stream: IO[bytes]) -> T_SECTIONS:
"""
Parse the sections of a Web Assembly module.
Parse the sections of a WebAssembly module.
"""
sections = _parse_sections(stream)
return normalize_sections(sections)
Expand Down
2 changes: 1 addition & 1 deletion wasm/parsers/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

def parse_version(stream: IO[bytes]) -> Tuple[numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8]:
"""
Parser for the version portion of a binary encoded Web Assembly module
Parser for the version portion of a binary encoded WebAssembly module
https://webassembly.github.io/spec/core/bikeshed/index.html#binary-version
"""
actual = (
Expand Down
2 changes: 1 addition & 1 deletion wasm/validation/modules.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def validate_function_types(module: Module) -> None:

def validate_module(module: Module) -> Tuple[Tuple[TExtern, ...], Tuple[TExtern, ...]]:
"""
Validatie a web Assembly module.
Validatie a webAssembly module.
"""
validate_function_types(module)

Expand Down
2 changes: 1 addition & 1 deletion wasm/validation/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

def validate_version(version: TVersion) -> None:
"""
Validate the parsed version string for a Web Assembly module.
Validate the parsed version string for a WebAssembly module.
"""
if version != constants.VERSION_1:
raise ValidationError(
Expand Down