Update documentation #739
Update documentation #739
Conversation
add .. autoclass:: BasePoint to Reference section.
Correct last commit to autoclass:: BasePoint
Add intersphinx mapping to python 3 inventory.
|
Looks like fontshell.font may need to be updated here: tests are run via fontShell, fyi. Though, not sure tbh if that is the issue. |
|
I think the issue simply is that I changed the name of the new module from |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #739 +/- ##
==========================================
- Coverage 78.30% 78.13% -0.17%
==========================================
Files 41 42 +1
Lines 6094 6157 +63
Branches 1017 1028 +11
==========================================
+ Hits 4772 4811 +39
- Misses 1116 1138 +22
- Partials 206 208 +2
|
|
The error was related to a misguided attempt of mine to fix a naming issue with the defaultLayer properties. I think the names of those are reversed, compared to their status as base vs. environment related. Anyway, reversing the changes I made, fixed the problem, and for fear of breaking something more, I haven't looked further into this, but you should definitely take a look at those properties. |
|
Hey @knutnergaard, I am very sorry, I was typing far too quickly in my reply about the name for |
I had some trouble with the lasts few commits from the terminal, but hopefully everything is ok now. Sorry about that! I'll update |
…methods in base/layer.py and fontshell/layer.py to return mappings to tuple. - Update base/layer.py with doc revisions and type annotations. - Update layer.rst accordingly. - Fix link to fontParts.world in various .rst files.
|
@benkiel, In |
|
@knutnergaard I think that |
Yes, that makes sense, but I see this error also occurs in other cases, like here, in the def swapLayerNames(self, layerName: str, otherLayerName: str) -> None:
...
self._swapLayers(layerName, otherLayerName) # Instance of 'BaseFont' has no '_swapLayers' memberI could not find any logic for BTW, after some revisions not yet committed, all type annotation and logic pass when running mypy on font.py:1360: error: "BaseFont" has no attribute "_swapLayers" [attr-defined]
font.py:2017: error: Signature of "isCompatible" incompatible with supertype "InterpolationMixin" [override]
font.py:2017: note: Superclass:
font.py:2017: note: def isCompatible(self, other: Any, cls: Any) -> Tuple[bool, str]
font.py:2017: note: Subclass:
font.py:2017: note: def isCompatible(self, other: BaseFont) -> Tuple[bool, str]
font.py:2095: error: "str" has no attribute "fatal" [attr-defined]
font.py:2095: error: "str" has no attribute "warning" [attr-defined]
font.py:2096: error: "str" has no attribute "fatal" [attr-defined]
font.py:2098: error: "str" has no attribute "warning" [attr-defined]I've edited the line numbers to reflect my latest commit of |
Just to be clear, should these references consistently be in the future tense in all modules? |
|
@knutnergaard yes, future tense when the value obtained by the private method will be normalized in the public method, past tense when the value given to the private method has been normalized by the public method before being handed to the private method. Hopefully that is clear (I know, confusing) |
|
Apart from adding documentation 9e869d5 also adds type annotation where missing and improves code generally. |
|
APPROVED! Thank you so much for all this work, I know it is a lot! |
This reverts commit 3d67a1d.
* Update normalizers.rst * Update normalizers.rst * Update point.rst add .. autoclass:: BasePoint to Reference section. * Update point.rst Correct last commit to autoclass:: BasePoint * Update conf.py Add intersphinx mapping to python 3 inventory. * Add new module for type annotation definitions. * Add type annotations and edit/add documentation. * Update font.py Correct import error. * fixed name discrepancy in defaultLayer properties. * Fix name discrepancy in defaultLayer properties. * Add overview and reference items. * Edit minor details. * Change to . * Revert "Change to ." This reverts commit e7152b0. i# * Changed type.py to types.py and updtated font.py accordingly. * Recommitting due to error. * - Update _getReverseComponentMapping and _getReverseComponentMapping methods in base/layer.py and fontshell/layer.py to return mappings to tuple. - Update base/layer.py with doc revisions and type annotations. - Update layer.rst accordingly. - Fix link to fontParts.world in various .rst files. * Revise documentation. * Add annotations.py. * Remove types.py. * Revise documentation. * Fixed type annotation. * Add documentation tools folder and module for docstring generation. * vert "Add documentation tools folder and module for docstring generation." This reverts commit fa52b70. * Add docstring generation module. * Refacor extraction of exceptions and normalizers with new CodeAnalyzer class. * Add type annotation. * Update fonttools from 4.53.1 to 4.54.1 (#746) * Revise and add annotation and documentation. - add Interpolatable protocol and compatible type variable to `annotations.py` - add and improve annotations and documentation in `base.py` * correct naming error. * Add/improve documentation. * Add documentation regarding review to `rererence` function. * Add/improve documentation. * Update base.py (#750) * update docstrings of `base.reference` and `BaseBPoint.type`. * Revise `annotations.py` with new generic container types. * Revert "Update documentation (#739)" This reverts commit 3d67a1d. * Resolve merge conflicts. * Add Sublime Text project folders. * Add Sublime Text project folders. * Remove unnecessary list comprehensions. * Remove Sublime Text project files. * Solve merge conflict. * Resolve merge conflicts. * Add Sublime Text project folders. * Resolve merge conflicts. * Resolve merge conflicts. * Resolve merge conflicts. * Add type aliases and improve names. * Revise type annotation in accordance with changes in `annotations.py` * Correct naming errors. * Tweak error message language * Fix type * Remove list comprehensions --------- Co-authored-by: pyup.io bot <github-bot@pyup.io> Co-authored-by: Ben Kiel <ben@typefounding.com> Co-authored-by: Ben Kiel <ben@benkiel.com>
|
👏 |
base/font.pybase/type.pydocumentation/source/conf.py