Skip to content

Conversation

@deven367
Copy link
Contributor

@deven367 deven367 commented Nov 4, 2025

This PR adds tests for the new parser that will be used in the when we will create new documentation. The idea is that the parser reads the .md file based documentation and when it sees a code block like this

# some title

other imp info ....

::: coreforecast.differences.num_diffs

renders to

# some title

other imp info ....

### `num_diffs`

```python
num_diffs(x, max_d=1)
```

Find the optimal number of differences

**Parameters:**

Name | Type | Description | Default
---- | ---- | ----------- | -------
`x` | <code>[ndarray](#numpy.ndarray)</code> | Array with the time series. | *required*
`max_d` | <code>[int](#int)</code> | Maximum number of differences to consider. Defaults to 1. | <code>1</code>

**Returns:**

Name | Type | Description
---- | ---- | -----------
`int` | <code>[int](#int)</code> | Optimal number of differences.

It will render the documentation for the fn/class in-place in the md file

@deven367 deven367 changed the title [tests] tests for the parser [tests] tests for the parser (coreforecast) Nov 4, 2025
@deven367 deven367 changed the title [tests] tests for the parser (coreforecast) [tests] tests for the parser Nov 5, 2025
@deven367
Copy link
Contributor Author

deven367 commented Nov 5, 2025

I've temporarily skipped the tests for datasetsforecast for now, I'm suspecting a python version/dependency issue. I can reproduce the issue in a codespace, but not locally.

Besides that the overall PR is in good shape to get some feedback and comments! :)

Copy link

@JQGoh JQGoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the given tests, they look good to me. But I suggest that we try to resolve the dependency issue and have validations for datasets cases that you mention.

@deven367 deven367 merged commit abc3c5b into main Nov 14, 2025
1 check passed
@deven367 deven367 deleted the tests branch November 24, 2025 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants