8000 generate a warning message when backslashes in namespaces are not escaped properly by xabbuh · Pull Request #14 · fabpot/sphinx-php · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Apr 16, 2022. It is now read-only.

generate a warning message when backslashes in namespaces are not escaped properly #14

Merged
merged 1 commit into from
Jun 11, 2014

Conversation

xabbuh
Copy link
Contributor
@xabbuh xabbuh commented Jun 10, 2014

Running a build now procudes an output like this if backslashes are not escaped (see #11):

sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.1.3
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] components/event_dispatcher/container_aware_dispatcher                                                                                        
/var/www/Symfony/docs/components/event_dispatcher/container_aware_dispatcher.rst:10: WARNING: backslash not escaped in :class:`Symfony\\Component\EventDispatcher\\ContainerAwareEventDispatcher`
/var/www/Symfony/docs/components/event_dispatcher/container_aware_dispatcher.rst:47: WARNING: backslash not escaped in :method:`Symfony\\Component\\EventDispatcher\ContainerAwareEventDispatcher::addListenerService`
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                                          
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 2 warnings.

Build finished. The HTML pages are in _build/html.

@fabpot
Copy link
Owner
fabpot commented Jun 11, 2014

Thank you @xabbuh.

@fabpot fabpot merged commit c0a4140 into fabpot:master Jun 11, 2014
fabpot added a commit that referenced this pull request Jun 11, 2014
… are not escaped properly (xabbuh)

This PR was merged into the 1.0-dev branch.

Discussion
----------

generate a warning message when backslashes in namespaces are not escaped properly

Running a build now procudes an output like this if backslashes are not escaped (see #11):

```text
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.1.3
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] components/event_dispatcher/container_aware_dispatcher
/var/www/Symfony/docs/components/event_dispatcher/container_aware_dispatcher.rst:10: WARNING: backslash not escaped in :class:`Symfony\\Component\EventDispatcher\\ContainerAwareEventDispatcher`
/var/www/Symfony/docs/components/event_dispatcher/container_aware_dispatcher.rst:47: WARNING: backslash not escaped in :method:`Symfony\\Component\\EventDispatcher\ContainerAwareEventDispatcher::addListenerService`
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 2 warnings.

Build finished. The HTML pages are in _build/html.
```

Commits
-------

c0a4140 generate a warning message when backslashes in namespaces are not escaped properly
7455374 Merge pull request #13 from clemens-tolboom/feature/add-files-to-gitignore
4549925 Fixed for @stof feedback.
485dc69 Fixed for @stof feedback.
b7e6032 Add files to .gitignore.
@xabbuh xabbuh deleted the issue-11 branch June 11, 2014 07:22
@stof
Copy link
Contributor
stof commented Jun 11, 2014

@xabbuh this is great. Can you update the submodule in the symfony-docs repo so that the Travis build benefits from this ?

@xabbuh
Copy link
Contributor Author
xabbuh commented Jun 11, 2014

@stof Yes, I will do that later. I just noticed that we should also raise a warning if a backslash is not escaped in the namespace directive. I'm also trying to evaluate if it is possible to hook into the versionadded role to warn when its contents is empty. When these things are done, I'll create a PR on the docs repo for an update.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0