Skip to content

Comments

Fix several bugs#114

Merged
llucax merged 10 commits intofrequenz-floss:v0.x.xfrom
llucax:fixes
Aug 15, 2023
Merged

Fix several bugs#114
llucax merged 10 commits intofrequenz-floss:v0.x.xfrom
llucax:fixes

Conversation

@llucax
Copy link
Contributor

@llucax llucax commented Aug 15, 2023

  • Don't add discovered extra path if it's a source path
  • Fix copying of Config and CommandOptions
  • Fix defaults.api_config documentation
  • Remove hack to account for the pytests directory
  • Sort mkdocs.yml import inventories
  • cookiecutter: Fix adding of an empty keyword
  • editorconfig: Use 4 spaces identation for Markdown files
  • Remove unnecessary py.typed file
  • Don't ship development files in source distribution
  • cookiecutter: Don't ship devel files in source distribution

llucax added 7 commits August 15, 2023 11:18
We don't want to have duplicated paths between extra and source paths
either, otherwise things will be processed twice.

Signed-off-by: Leandro Lucarella <[email protected]>
When copying these dataclasses we also need to copy the lists that they
hold, otherwise if there are in-place updates the copied instances will
be affected too.

Signed-off-by: Leandro Lucarella <[email protected]>
The documentation was outdated.

Signed-off-by: Leandro Lucarella <[email protected]>
API repos use a non-standard directory to store tests (`pytests`),
because of this, the directory should be configured in `pyproject.toml`
and since we auto-discover test directories from there, there is no
need to keep the hack that will add `pytests` to the `extra_paths` for
API repos.

Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
When pressing ENTER while being asked for project keywords, an empty
keyword ("") was added. This commit fixes that.

Signed-off-by: Leandro Lucarella <[email protected]>
This is because mkdocs doesn't render numbered lists correctly if they
have more than one paragraph using less than 4 spaces indentation.

For example, this:

```md
1. A list item.

   This list item gets improperly rendered.
```

Gets rendered like this in HTML:

```html
<ol>
<li><p>A list item./<p></li>
</o>
<p>This list item gets improperly rendered.</p>
```

While this:

```md
1. A list item.

    This list item gets improperly rendered.
```

Gets rendered like this in HTML:

```html
<ol>
<li>
<p>A list item.</p>
<p>This list item gets improperly rendered.</p>
</li>
</o>
```

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax requested a review from a team as a code owner August 15, 2023 09:34
@github-actions github-actions bot added the part:tests Affects the unit, integration and performance (benchmarks) tests label Aug 15, 2023
@llucax llucax self-assigned this Aug 15, 2023
@llucax llucax added this to the v0.5.0 milestone Aug 15, 2023
@llucax llucax added part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:bug Something isn't working part:cookiecutter Affects the generation of projects using cookiecutter part:docs Affects the documentation part:nox Affects the configuration of nox part:mkdocs Affects the configuration of mkdocs labels Aug 15, 2023
@llucax llucax enabled auto-merge August 15, 2023 09:35
llucax added 3 commits August 15, 2023 11:51
The file in `src/frequenz/` could conflict with other packages, and we
really need to provide the file for the whole `frequenz.repo` package as
it is the top-level package here, so we can do `from frequenz.repo
import config`.

Signed-off-by: Leandro Lucarella <[email protected]>
There are a lot of files that are only used for development purposes
and should not be distributed in the source distribution package, as
this package should only include the files necessary to build the wheel.

We still ship basic documentation (like the README, release notes and
license as they are very lightweight and carry important information).

Signed-off-by: Leandro Lucarella <[email protected]>
There are a lot of files that are only used for development purposes
and should not be distributed in the source distribution package, as
this package should only include the files necessary to build the wheel.

We still ship basic documentation (like the README, release notes and
license as they are very lightweight and carry important information).

Signed-off-by: Leandro Lucarella <[email protected]>
@github-actions github-actions bot removed part:mkdocs Affects the configuration of mkdocs part:docs Affects the documentation part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) part:nox Affects the configuration of nox labels Aug 15, 2023
@github-actions github-actions bot removed the part:cookiecutter Affects the generation of projects using cookiecutter label Aug 15, 2023
@llucax llucax added this pull request to the merge queue Aug 15, 2023
Merged via the queue into frequenz-floss:v0.x.x with commit e86859d Aug 15, 2023
@llucax llucax deleted the fixes branch August 15, 2023 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:tests Affects the unit, integration and performance (benchmarks) tests type:bug Something isn't working

Projects

Development

Successfully merging this pull request may close these issues.

2 participants